Summary
<技术文档写作-2>主要介绍如下中级内容：
- 选取文档风格要求
- 像读者一样思考
- 大声朗读文档
- 写完草稿后检查草稿
- 找到合适的审阅人
- 为文档建立大纲。即，先草列再组织文档。
- 介绍文档的覆盖范围和阅读文档的前提。
- 使用基于任务的标题。
- 循序渐进（在一些情况下）。
- 创建插图前先写插图标题。
- 控制单个插图内的信息量。
- 使用标题说明或图内标注强调图片重点。
- 提供易理解的简洁的范例代码。
- 代码注释应简短，但应该优先保证准确性。
- 避免给不言自明的代码写注释。
- 将注释的精力放在代码中意义不明显的地方。
- 提供证明和反面范例代码。
- 提供不同复杂度的代码。
- 持续修正。
- 为不同类型的用户提供不同的文档。
- 和读者熟知的内容做类比和对比。
- 在教程中，通过示例强化概念。
- 在教程中，标注读者可能碰到的问题。
如果时间允许，请阅读附加材料。