This simple list presents writing tips I summarize for technical writing.
Audience
- Know your audience.
- Understand their goals.
- Do not overestimate the technical ability of your audience. Do not frustrate your audience by underestimating their skill levels as well.
Simplicity
- Use active verbs.
- Get to the point quickly.
- Use simple language and short sentences (for complex information).
- Use lists:
- Use bullets for unordered lists.
- Use numbers for ordered lists.
Consistence
- Use consistent terminology, syntax, and formatting.
- Use the present tense.
- Address readers in the second person.
Structure
- Make your writing scannable—Put all the important information at the top, followed by supporting details (pyramid structure).
Others
- Use examples to clarify complicated concepts.
- Test your instructions or ask your team to check for accuracy.
英文技术写作系列