Know Your Audience

• Before creating any type of technical documentation, identify the intended audience. This defines how technical or complex you can be. If you are creating documentation for engineers, you do not need to explain every single detail of the topic; they already have an understanding of the subject matter. However, if you are creating materials for students or a novice audience, you must explain technical details and provide more background material. If you are not sure about the technical level of your audience, consider reviewing the documentation with sample members of the intended audience.
  
  

Procedures

• Whether it's paper manuals or online help, instructional procedures are the most common type of documentation technical communicators create. When writing procedures, consider the intended audience. A novice audience needs all steps in a procedure listed for them. Don't assume that they know even the most basic information. However, a more technical audience won't need everything explained. A programmer understands the basics of software installation. Engineers understand how to connect a mouse to a computer.
  
  Break down the procedure into clear, numbered steps. Don't group several instructions together in one step. This can confuse even the most experienced audience. Also, remember to include all important tips or warnings that the user will need. Insert all warnings with the corresponding step; don't list them at the end of the procedure. Typically, tips can be added anywhere, either with the step, at the beginning of the document or at the end.
  
  

Eliminate Jargon

• Because technical communicators frequently work with engineers, programmers, scientists, etc., jargon, abbreviations and acronyms are common. Technical jargon has no place in effective technical communication. Replace it with clearly worded content and understandable terminology. Spell out abbreviations and acronyms the first time they are used, followed by the abbreviation or acronym in parentheses. After that, use the abbreviation or acronym, as necessary.
  
  

Keep it Simple

• It's important to remember that, as a technical communicator, you are not writing a novel. Avoid unnecessary adjectives or other descriptive phrases. Describe items simply, but accurately. Write using active language, providing a clear direction for the user. Also, use a vocabulary that is appropriate for your audience. Doctors, engineers or others with advanced college degrees will understand a more complex vocabulary. However, if your document is intended for a broad audience, use a simpler vocabulary. If you cannot avoid more difficult vocabulary for some content, define these words, either within the document or in a glossary.
  
  

Illustrations

• Don't hesitate to use photos or illustrations in your technical documentation. Both are very useful in clarifying complex technical content, particularly procedures. However, illustrations should only include the necessary information and be appropriate for the audience. A complex electrical diagram will not help new users understand their first computer. However, an illustration showing the different parts of the computer will be very valuable.
  
  Also, use an image-editing program to remove anything unnecessary or crop the image to focus only on the part you need. Use callouts to highlight specific, important details.