如何概述技术写作文件。写得不好的文件不是偶然创造的。计划,组织和编写报告,手册或其他技术文档中涵盖的材料。文档的概述阶段是关键步骤,如果未创建轮廓,则可能无法以逻辑方式显示信息。概述使作者有机会思考应该和不应该包括的信息。
集思广益你的想法。写下您认为应该包含在技术文档中的大纲中的任何想法。不要关心信息的顺序。重要的是所有信息都包含在头脑风暴过程中。
确定技术文档的目的。问自己一些问题,例如谁将阅读文档,为什么要阅读它以及如何使用它。
确定您要创建的大纲类型:历史,按时间顺序排列,特定于一般,从小到大,从简单到复杂或任何其他适合内容的形式。考虑观众和您想要呈现的信息。确保信息的排列方式最适合所呈现的信息类型以及将阅读技术文档的受众。
按适当顺序排列信息。大纲涉及将信息分组为逻辑部分和级别。您可以创建主要主题和子主题以及子子主题。
通过查看信息来完成大纲,以验证主题是否在逻辑上得到了适当的组织。确保您没有遗漏任何关键事实。删除与技术文档无关的任何信息。