【经验谈】技术文档写作之重要原则

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 underestimate 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

• Address readers in the second person.
• Use consistent terminology.
• Use present tense.

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.

英文技术写作系列

• 技术文档工程师六大必杀技
• 英文技术写作：中国人常犯的语法错误(Common Mistakes in Writing)
• 英文技术写作：Writing Guidelines
• Minimalism Writing: 简简单单就好--走出技术写作的误区
• Topic-Based Writing: Planning Your Topics