Introduction

• The intro defines the manual. Explain who should read the document and who is it not meant for, what information is included and in what circumstances is it useful. For product manuals, assume the reader has purchased the product and is ready to learn how to use it. Keep the introduction short so the user gets to the technical aspects of the manual as quickly as possible.
  
  

Outlines

• Technical manuals are often laid out in sections and subsections, which also make an ideal outline. List all the planned sections for the manual and included detailed subsections where necessary. Don't be afraid to rearrange the sections as you progress. Just because you thought of topic A first doesn't mean the reader needs that bit of information first. The final order of the sections should reflect the natural progression the user will make while learning the topic. Use a noun and verb in the section heading to define the item and action within the section.
  
  

Be Active

• Each step in a technical manual instructs the reader in a single action that, when performed with other steps, leads to a complete action. Number the steps or have graphic "bullets" to indicate the steps. In some situations, the steps may be sub-steps identified by numbers or letters under the basic steps. Writers have some discretion in how they identify steps, but should be consistent throughout the manual.
  
  

Keep It Simple

• Use the simplest language that adequately conveys the information. You don't know who will read the manual and how well they are versed in the technical jargon of the topic. Avoid high levels of detail or details not necessary to convey the information. Long sentences, more than 20 words, tend to discourage readers. Sentences of less than 10 words can give the document a chopping sound.
  
  

Illustrate the Topic

• Use photographs, charts or graphs to illustrate the topic. These images can be worth a thousand words and tend to draw the reader's eye. If graphic images aren't possible, use descriptive sentences. Verbal examples and illustrations also allow the reader to visualize the topic.