| Home |
 |
Student Resources |
|
Chapter 11: Product-Oriented Communication Situations |
|
Sample Documents |
|
Criteria for Brief Instructions and ProceduresContent
For procedures, the descriptions, explanations, and background information are easy to understand and suited for the intended audience.
The instructions are precise; no steps or sub-steps are omitted.
Diagrams or other visuals are included to help users visualize the device and to help them perform the task.
Examples are included, as necessary, to help readers understand particular steps.
The instructions are accurate.
When appropriate, procedures include the procedure number and dates.
Arrangement
The introduction includes a brief overview of the task.
The steps are numbered and sequenced in the exact way the procedure will be performed.
For complex steps, each sentence begins on a new line.
All information necessary to perform a step is grouped.
Headings break up the information and help to guide users through the procedure. That is, headings accurately forecast what users are expected to do.
Notes, cautions, and warnings are included where necessary and appear before the step.
Visuals are close to the steps they clarify.
Style
All steps begin with action verbs in the imperative voice.
Sentences are short so that readers readily understand the step to be performed.
All information is written at the audience's level of technical expertise.
Transitions are adequate to guide users through the steps.
Heading levels are grammatically parallel.
All words are spelled correctly.
The style is clear, concise, fluent, and grammatical.
|