技术作家的 10 条戒律

[account_disabled]

技术作家的主要目标是以简洁的方式传达想法。优秀的技术作家不一定是英语或传播学硕士学位。技术作家所需要的只是对软件/产品/应用程序和基本语法知识的清晰理解。我们在这里向技术作家提出 10 条戒律，让您的技术写作工作变得更加轻松。 1.了解你的目标 在开始写作之前，尝试了解您计划编写的技术文档的目标。问问自己“你会写什么”和“你为什么要写它？” 当你得到答案后，就开始制定技术文档的大纲。 2.了解你的读者 技术文档的主要目的是为读者服务。因此，识别你的读者非常重要。

请记住，您的读者不了解您的产品/应用程序，这就是他/她阅读该文档的原因。专注于读者将在文档中寻找的关键思想。相应地进行计划。 3. 规划信息流 规划好文档的结构后，请考虑流程。决定文档应 电话号码清单 包含哪些部分，并为每个部分及其小节编写一个小纲要。以这样的方式进行规划，使读者从熟悉的信息转移到新的信息。此外，切勿以第一人称撰写文档，在叙述时使用第三人称。让你的写作切中要点。删除任何不支持你观点的内容。 4. 使用模板 好的技术写作是在模板上完成的。模板包含段落样式、每个页面元素的布局，例如页眉、页脚、标题、表格、段落、步骤、注释、预防信息等。



它还包含每个书籍元素，例如封面、扉页、目录、章节、术语表、封底等。除此之外，写在模板上的文档也便于读者阅读和将来编辑。 模板是可重复使用的。设计一次，需要时使用。这将节省时间和金钱。 5.添加命名部分 始终在文档的开头添加命名部分，并一致地使用所述命名约定。根据概念的用途来命名它总是更好。也将其应用于文件命名约定。始终为图形或图表命名并提供良好的标题。这可能包含多个提供上下文和解释的句子。