如何编写技术文档(write technical documentation)

技术交流或文档是通过向目标受众书写特定主题来传达“用户友好”信息的过程。技术文档包括业务电子邮件、业务报告、用户指南或帮助系统。许多人只有在“其他一切都失败”的情况下才求助于文档。难怪文档充其量也是劣质的；更糟的是根本不存在。计算机公司可能觉得他们的软件很简单，他们不需要文档。但是技术文档比技术支持电话要便宜。在开发良好的技术文档之前，您需要知道有效的技术文档是一项精心规划和执行的任务。...

你需要的东西

计算机
创作工具
主题专家

确定目的和受众。您需要知道为什么要创建此文档以及谁将阅读它。如果您的受众是汽车修理工，您创建的文档类型将不同于如果您的受众是软件工程师。

收集信息。创建文档的人通常是作者，而不是主题专家。重要的是要收集信息，以便您可以将其记录下来。收集信息可能意味着进行研究，采访主题专家，或者对产品本身进行实验，比如软件程序。

组织和概述信息。您可以从现有文档或模板开始。输入您拥有的信息并将需要收集更多信息的区域留空是很重要的。这将是你的工作文件，你将在此基础上继续努力。记下你所拥有的东西，即使你有大面积的空白，也会增强你在项目中前进的信心。

写初稿。这是当你开始填补空白，允许思想流从你的意识流。不要在这个阶段通过修改来阻止这种流动。

修改和编辑。您可能希望将文档放在一边一段时间，以便重新查看。然后关注需要更多关注的话题；缩短、扩展或删除节；或者重新排列段落、句子或整个主题。您还需要编辑样式、语法和上下文。

笔记

编辑检查表很方便，因此您可以在单独的过程中编辑不同的点。

培养良好的团队合作能力，并了解每个主题专家喜欢如何工作，以避免这种关系变得敌对。

发表于 2021-11-26 12:43
阅读 ( 154 )
分类：文学

你可能感兴趣的文章

学术的(academic)和技术写作(technical writing)的区别

学术的(academic)和技术写作(technical writing)的区别学术写作和技术写作是两种写作形式，它们之间有一个关键的区别。大多数人认为技术作家实际上也是学术作家。然而，这是一个错误的假设。尽管学术写作和技术写作都需...

发布于 2020-10-28 14:51
阅读 ( 414 )

什么是javascript？它是如何工作的？

...的部分需要学习：web浏览器的工作原理和文档对象模型（documentobjectmodel，DOM）。 ...

发布于 2021-03-18 04:01
阅读 ( 272 )

技术写作(technical writing)和文学写作(literary writing)的区别

技术写作的主要区别(main difference technical writing) vs. 文学写作(literary writing) 技术性写作和文学性写作是两种重要的写作风格，它们依赖于写作的主题、目的和读者群。技术写作与文学写作的主要区别在于，文学语言是文...

发布于 2021-06-28 10:46
阅读 ( 470 )

技术写作(technical writing)和创造性写作(creative writing)的区别

...育读者，并以合乎逻辑的方式呈现。什么是技术写作(technical writing)？写作现在是一个广阔的领域，因为它不仅仅局限于在报纸或杂志上写作。它还拥有许多类型，产生了巨大的收入，除了普通人只知道两种类型的写作，小说...

发布于 2021-07-08 12:21
阅读 ( 236 )

使用writing room 4 google文档获得更多工作空间

Firefox with Greasemonkey:Writing Room 4 Google Documents Greasemonkey脚本可以切换和隐藏Google文档中书写和编辑页面功能工具栏上方的徽标和空格。那些屏幕较小、分辨率较低的用户会欣赏这个小脚本为他们提供的额外书写空间，但它可以帮...

发布于 2021-07-30 15:34
阅读 ( 110 )