Introduction

<技术文档写作2>的目标是帮助技术人员提升其技术沟通能力。

目标受众

本课程的目标受众是完成了<技术文档写作1>系列课程的,且希望得到更多技术写作相关训练的人员。如果你从未接受过任何技术写作培训,建议你先完成<技术文档写作1>系列课程。

学习目标

本课程侧重于技术写作的几个中级主题。学完本课程后,你将学会如下内容:

  • 选择几种不同的策略来编写初稿,并使用更多技巧来编写第二稿和第三稿。
  • 使用几种技术来检查自己写作中的错误。。
  • 对大型文档进行组织。
  • 介绍文档的范围以及先决条件。
  • 如何写出清晰的图示标题。
  • 技术插图中合理地选择信息密度。
  • 吸引读者注意力到插图上。
  • 使用“大图”阐述建立上下文。
  • 有效地修改技术图示。
  • 创建有用的、精确的、简洁的、清晰的、可重用的以及合理注释的示例代码。提供示例代码集应该有不同的难度,来帮助不同层次的读者理解。
  • 区别不同的文档类型。
  • 讨论任何问题。

[!NOTE]

译注,原文是Describe just about anything。含义应该是文档尽量保证完整面面俱到。

  • 对读者中的初学者抱有同理心,并为他们写手册。

成为一名优秀的工程师或优秀的技术作家需要多年的专注实践。本课程将提高您的技术写作能力,但不会立即将您转变为出色的技术写作专家。

课前和课上内容

课程由以下两个部分组成:

  • 课前内容
  • 课上内容

本文档是课前材料。课上内容是课前材料内容的增强。尽管如此,课前内容还是非常有价值的材料。

Reference

原文: https://developers.google.com/tech-writing/two

Copyright @ Lambert 2022 all right reserved,powered by GitbookModified Time: 2024-02-24 14:20:10

results matching ""

    No results matching ""