程序员-文档工程师.ppt

程序员成长系列之—— 从程序员到文档工程师 从程序员到文档工程师 从某个角度看“程序员”这个称呼已经无法涵盖软 件公司中各种角色的职责和特点，成熟软件公司中会有 这个职位，但是在很多小规模公司中，文档工程师只是 一种角色，而不一定有职位设置。 程序员成长方向 从程序员到文档工程师 在国外，文档工程师是非常重要的角色，因为他要接受大量的、 高水准读者的考验，而且要跟踪不断创新的技术，感受产品周期 的压力，其重要程度不亚于系统分析员。以加拿大为例：同样四 年经验的系统分析员的薪水在￥55000；而文档工程师为￥65000 属于专业职能，在技术移民中的评分为50，高于牙医、建筑设计 师，电机工程师（40）等工作种类。 然而在国内，人们的印象中，文档工程师还是属于低级“码字” 的角色，很多“真正的”程序员对此工作不屑一顾。不过随着软 件业的规范，国外先进软件开发方法的进入和推广，文档工程师 越来越受重视，在chinaHR／51job等人才招聘网站，每星期都有 很多空缺。 从程序员到文档工程师 由于软件开发中项目繁多，输出文档的分散和更新 不及时，开发人员使用的工具多样化，多种版本和工具 并存种种原因导致开发过程中存在很多问题。部门主管 无法确切得知项目的进展情况，项目经理不能准确掌握 各开发人员的具体工作，项目进展随意性较大；项目之 间沟通不够各个开发人员编写的代码风格差异，而且编 码和设计脱节。如果沟通不及时或被忽视，容易造成开 发工作的重复，留下大量难维护的代码；文档与程序严 重脱节，软件产品是公司的宝贵财富，代码的重用率是 相当高的，因此建好知识库是对公司优质高效开发产品 的推动。这些问题的解决都需要文档工程师的积极参与. 从程序员到文档工程师 文档工程师的职责： 在RUP（统一软件开发过程）中，文档工程师负责 内部软件文档、用户手册编写及演示版本的制作，除此 之外，软件开发过程中的文档控制与规范也属于文档工 程师的职责范围。 实际上，在软件开发过程中，文档很难单独存在， 它需要由文档工程师和开发人员共同完成。其中开发人 员扮演信息源的角色，文档工程师扮演一个信息处理中 心的角色，主要负责文档工作的质量。 从程序员到文档工程师 收集/提出文档需求 安排文档开发计划 制定各类文档模板 跟踪文档编写进度 编辑文档 文档的管理 从程序员到文档工程师 收集／提出文档需求： 对设计部门文档的需求来自项目外（客户，市场部 维护部门，其他项目等）或者项目内。文档工程师需要 有良好的沟通技巧。通过与客户和其他部门的交流，获 得他们在文档方面的需求，项目内的文档需求可以根据 软件工程的知识，由项目经理或文档人员自己提出。 从程序员到文档工程师 安排文档开发计划： 文档开发计划是在需求达到一定程度后，安排计划 编写的相应文档。文档开发计划的制定需要考虑目前开 发人员的开发任务，文档需求的紧急程度，文档编写的 难度等因素。所以文档开发计划的安排主要应该由项目 经理来负责，其中文档工程师起协助的作用。但是，如 果文档工程师对项目有足够的了解，计划草搞可以由文 档工程师制定，再由项目经理确认。 从程序员到文档工程师 制定各类文档模板： 制定各种模板是文档工程师的主要职责之一，文档 模板和文档编写的指南对统一文档风格非常重要，因为 大部分的文档需要各个开发人员编写不同的部分，如果 没有统一的模板和明确的指南，很可能开发人员提交出 风格各异，详细程度不同的文档，这给后期的编辑工作 带来了很大的困难，而且文档质量难以控制。 文档模板可以根据经验制定，也可以参考一些成熟 的开发模型如RUP提供的参考模板，删节修改后在项目内 使用。 从程序员到文档工程师 跟踪文档编写的进度： 在项目经理确定文档开发计划，把任务分配给具 体的开发人员后，文档工程师需要不断的跟进文档编 写任务的完成状况。跟踪进度的工作可以通过一些项 目管理工具来辅佐。 从程序员到文档工程师 编辑文档： 编辑文档就是对开发人员提交的原始文档进行合并 整理，修改，统一语言风格等工作。完成后，由文档工 程师初步检查一次，成为一份草稿状态的文档，然后将 文档提交给相关的人员检查，如项目经理或CTO，其他 部门负责人等，检查人发现需要校正的地方，应该独立 做校正表，或者在原文档中做批注，而不应直接修改原