CHECKLIST FOR REVISING THE REPORT

DOCUMENT #6

This checklist is adapted from materials provided by John M. Lannon
for use with the textbook adopted for this course, Technical Communications.

IS THE ORGANIZATION SENSIBLE?
  • Structure of the document visible at a glance

  • An evident line of reasoning

  • A distinct introduction, body, and conclusion

  • A section's length is equal to its importance

  • Enough transitions and connectors to signal relationships

  • Material organized for best emphasis

  • A topic (orienting) sentence to begin each supporting paragraph

  • One main point developed in each supporting paragraph, with unity, coherence, and reasonable length

IS THE STYLE READABLE?
  • Each sentence understandable on first reading (clarity)

  • Most information expressed in fewest words (conciseness)

  • Sentences varied in construction and length (fluency)

  • Each word chosen for exactness

  • All definitions double-checked

  • Abstractions and generalizations replaced by concrete, specific, and exact language

  • No triteness, overstatements, euphemisms, or inappropriate jargon

 

IS THE CONTENT WORTHWHILE?
  • A brief but explicit title

  • Subject and purpose clearly stated

  • Enough information for readers to understand the meaning

  • Material (or insight) new and significant to the audience

  • All material technically accurate

  • Technical details appropriate for the audience

  • All needed warnings and cautions

  • All data examined fully and interpreted impartially

  • Both sides of the issue presented

  • Opinions and assertions supported by evidence

  • Conclusions and recommendations supported by the facts presented

  • No recommendations where none were requested

  • No gaps, foggy areas, or needless details

  • All anticipated reader questions answered

  • All sources of data documented

ARE FORM, FORMAT, VISUALS, AND MECHANICS APPROPRIATE?
  • Best document form (letter, memo, report) for stated purpose and audience

  • Attractive and appealing format (white space, typeface, and so on)

  • Adequate, clear, and informative headings

  • Adequate and appropriate visuals, to clarify meaning and create interest

  • All visuals properly introduced, integrated, and explained

  • All pages numbered and in order

  • All needed supplements (title page, abstracts, and so on) included

  • Correct spelling, punctuation, and grammar

Report written by:

Peer review completed by:

 

 

 

Last Updated 8/25/99