技术文档写作的工作流程
当我们探索新手机，组装新家具，使用新电器时，我们可能会遇到这样或那样的问题。而解决这些问题的时候，我们往往会查阅它们的说明书、安装手册、用户手册之类的文档。这些文档都属于技术文档。那么，技术文档是怎样生成的呢？本文将根据我自己实际工作经验，以软件行业为例，详细介绍技术文档生成的过程。
-
收集软件需求，确定工作范围
每一版本的软件都有其目的，要么是增删功能，要么是修复缺陷，要么是更新某个组件，要么是为了符合某些规则和规定，要么是兼而有之。在正式开始写文档之前，文档工程师要向软件产品负责人及项目组带头人了解马上要开发的版本有哪些要做的事情，从而为接下来的计划环节做准备。
-
制定PI计划
软件开发是一项快节奏的工作。通常采用敏捷开发的方法。最典型的就是 Program Increment (PI) Planning。PI是时间单位，每个PI又分为Sprint。通俗来讲，你可以把一个PI想象成一年，每个季节是一个Sprint。假如农民想做一个计划，他可能春季（Sprint 1）播种；夏季（Sprint 2）浇水，施肥，除草，驱虫；秋季（Sprint 3）收割，打粮，磨米，储藏；冬季（Innovation and Planning Sprint，这是每个PI最后一个Sprint的名称，主要任务是总结、学习、创新、准备计划）总结全年的得与失，学习农业技术，创新耕种方法，为下一年计划做准备等。
说完了PI Planning，我们继续说技术文档工程师怎么做计划。首先，他要把从产品负责人那里收集来的任务分成单个小点，每个小点需要多长时间。比如：
- 研究某某功能 1天
- 写某某功能的草稿 3天
- 请开发审阅某某功能的草稿 1天
- 请技术文档工程师同行审阅我的草稿 1天
- 把写好的文档生成出来，安装最新的软件包，并检查文档格式 1天
- ……
文档工程师把这些点都列完之后，他要根据工作的先后顺序把这些小点分配到各个Sprint中去。最终实现的效果就是：他所计划的这些小点，都能在当前PI中完成。
做完计划，接下来就是着手写作。
-
写出技术文档
写文档是一个不断修改的过程，需要和开发、测试、同行文档工程师多次咨询技术问题，观看产品功能展示，征求审稿意见。
-
完成最终审阅
当这个版本软件的所有文档都写完的时候，文档工程师要把最终文档按照规定的格式输出出来，最后一次发给开发、测试、产品负责人、文档工程师同行审稿，审稿通过后，方可将文档放到最终的软件包。
-
检查最终文档
这个环节需要安装最终软件包，检查文档是否成功地放进了软件里，格式有没有错误，所有新写的内容是不是都在。
-
把文档上传到公司官网
有的公司可能会要求文档在安装包里一份，网上一份。只需要按照一定的步骤在某个时间点前把文档成品传上去，确保正常显示即可。
-
存档文档的源文件
一般是把文档的工程文件存到Git。
-
更新各种记录文件和报告
通常需要更新产品信息表，追踪表，各种报告。做完这些就意味着一个版本的工作结束了，随即就是开启下一版本的工作。周而复始。
以上就是技术文档写作的整体流程。但不同公司、不同团队多多少少都有些差别。
