Writing deliverable: instructions and procedure
|
Aside from purpose, audience is perhaps the most important consideration in planning, writing, reviewing and distributing a technical document. Lack of audience analysis is one of the root causes of most of the problems you find in professional and technical documents—particularly instructions where the smallest mistake can mean a law suit, injury, or death. |
||
|
Item: |
Deliberate and Considered Answer: |
|
|
Type of Audience: · Expert · Novice · Non-expert Name this audience: |
|
|
|
Audience Background: · Knowledge · Experience · Training |
|
|
|
Audience Needs: · What do they need to know about the topic? · What might they want to know about the topic? · What might they already know about the topic? |
|
|
|
Writer: · What do you think they need to know over and above what is already listed in the Needs category? |
|
|
|
Adaptations: What additional information do your readers need to know in order to understand the information? · Definitions of key terms · Descriptions of tools · Background information · Examples · Graphics/charts/visuals |
|
|
|
Design: What design items might you incorporate to help your reader understand the material? · Shorter sentences · Chunking information · Headings · Subheadings · Warnings · Bold text · Lists · graphics · white-space |
|
|