技术文档流程小结

技术文档作者就像一个translator，将产品介绍给用户，用深入浅出的语言。要把自己熟悉的一个朋友介绍给一个新的朋友，嗯，就是这么一个过程。
首先自己和产品要很熟，产品的功能点，各种实测指标，区别去其他产品的特性，还存在的缺陷，使用的技术等等方方面面。怎么样和产品很熟，这里就是像学生一样去学习，操作产品，像记者一样和研发，测试人员了解产品的知识，这就是一个获取写作素材的过程。
然后根据用户的情况，用户的知识水平，用户的期望等，选择合适的角度，逐步展开阐述产品方方面面的每一面。用户的情况需要进行一个详细的分析定位，不同的用户是不一样的！根据他们的情况把握写作的“度”，是需要一步一步机械式介绍还是点到为止。具体写作遵循的原则就是金字塔原理，还有不同公司制定的语言规范。
然后在公司内部进行同行评审peer review，邀请研发人员，测试人员，售前人员，售后人员，文档专家等。同行评审是一个质量控制手段，有助于准确性，实用性。
然后拿着写成的初稿给一个典型的用户读，如果他觉得赞就ok了，一般还是会有疑问的，或者不满意，如果不满意，一定是你写作的姿势不对，不，是没有站在用户角度去写作。你需要根据用户的反馈回来修改你的文档，然后再拿给他，然后再修改，迭代开发哦。如果用户是个美女，干脆坐在一起写好了。
以上就是一份技术文档的开发过程，如果考虑到将产品介绍给用户是一种知识服务，你做的还不够，还有一些需要注意的环节：
对内->
文档源文件的管理，涉及到内容管理，版本管理，可以使用版本管理软件，由专门的配置管理人员来管理版本演进，定期归档。
不同人员间的协作，涉及到不同部门不同岗位的人员，使用内部的共享网络，制定相关流程，确保沟通畅通，能协同开发。
对外->
文档的获取途径，公司能够提供多种文档格式，HTML和PDF是常见的，多个产品的多套文档需要合理组织，提供电子和实体的获取途径，方便用户查找和获取。
帮助用户提升技能，设计适合用户的技能提升路径，引导用户进行不同阶段的学习，并进行相应资质的测评。