美文网首页技术写作技术文档写作
英文技术写作:Writing Guidelines

英文技术写作:Writing Guidelines

作者: Joy的未来十年 | 来源:发表于2017-04-20 15:22 被阅读81次

    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.

    英文技术写作系列

    相关文章

      网友评论

        本文标题:英文技术写作:Writing Guidelines

        本文链接:https://www.haomeiwen.com/subject/whjlzttx.html