程序员-文档工程师.pptxVIP

程序员成长系列之——;从程序员到文档工程师;;从程序员到文档工程师;从程序员到文档工程师;文档工程师的职责： 在RUP（统一软件开发过程）中，文档工程师负责 内部软件文档、用户手册编写及演示版本的制作，除此 之外，软件开发过程中的文档控制与规范也属于文档工 程师的职责范围。 实际上，在软件开发过程中，文档很难单独存在， 它需要由文档工程师和开发人员共同完成。其中开发人 员扮演信息源的角色，文档工程师扮演一个信息处理中 心的角色，主要负责文档???作的质量。;收集/提出文档需求 安排文档开发计划 制定各类文档模板 跟踪文档编写进度 编辑文档 文档的管理;收集／提出文档需求： 对设计部门文档的需求来自项目外（客户，市场部 维护部门，其他项目等）或者项目内。文档工程师需要 有良好的沟通技巧。通过与客户和其他部门的交流，获 得他们在文档方面的需求，项目内的文档需求可以根据 软件工程的知识，由项目经理或文档人员自己提出。;安排文档开发计划： 文档开发计划是在需求达到一定程度后，安排计划 编写的相应文档。文档开发计划的制定需要考虑目前开 发人员的开发任务，文档需求的紧急程度，文档编写的 难度等因素。所以文档开发计划的安排主要应该由项目 经理来负责，其中文档工程师起协助的作用。但是，如 果文档工程师对项目有足够的了解，计划草搞可以由文 档工程师制定，再由项目经理确认。;制定各类文档模板： 制定各种模板是文档工程师的主要职责之一，文档 模板和文档编写的指南对统一文档风格非常重要，因为 大部分的文档需要各个开发人员编写不同的部分，如果 没有统一的模板和明确的指南，很可能开发人员提交出 风格各异，详细程度不同的文档，这给后期的编辑工作 带来了很大的困难，而且文档质量难以控制。 文档模板可以根据经验制定，也可以参考一些成熟 的开发模型如RUP提供的参考模板，删节修改后在项目内 使用。;跟踪文档编写的进度： 在项目经理确定文档开发计划，把任务分配给具 体的开发人员后，文档工程师需要不断的跟进文档编 写任务的完成状况。跟踪进度的工作可以通过一些项 目管理工具来辅佐。 ;编辑文档： 编辑文档就是对开发人员提交的原始文档进行合并 整理，修改，统一语言风格等工作。完成后，由文档工 程师初步检查一次，成为一份草稿状态的文档，然后将 文档提交给相关的人员检查，如项目经理或CTO，其他 部门负责人等，检查人发现需要校正的地方，应该独立 做校正表，或者在原文档中做批注，而不应直接修改原 文档，最后的校正工作由文档工程师根据校正表或者批 注完成，成为一份核实状态的文档。在需要发布的时候 应该先对文档做评审，通过评审才能标识为发布状态。 测试人员可以认为是特殊的文档人员，负责编写／编辑 测试文档。 ;文档的管理： 文档工程师应该负责：集中存储所有文档资料； 文档的变更管理；保证文档版域代码版本的一致性； 维护文档资料的索引表；配合IT人员定期备份文档 资料。;如何做好文档工程师 ： 要做好文档工程师的工作，首选要明确文档的价值所 在。从信息载体角度看，文档中记录的可能是杂乱无章的 数据，这些信息在某个项目或阶段完成后就无用了，同时 也可以通过提取信息中的知识，提高其价值，甚至可以变 成公司的资产。 软件文档分为内部文档和外部文档。内部文档主要是 用来做决策支持，外部文档一般指用户文档（主要是软件 说明文档）和客户文档（主要是需求文档）。文档工程师 只有了解这些，才能更好的看待文档的价值。;文档工程师的工具： 文档工程师除了要学会利用Word、Ebook、Help、 Visio、Html、Project Powerpoint、Acrobat等各种软 件，还要尽可能学会使用软件工程的软件来协助提高 工作效率，同时提高自身素质。;文档的分类： 在软件开发中，需求定义、规格说明、开发计划、 使用说明、联机帮助等各种过程都会产生大量文档， 都需要文档工程师参与。有些开发方法甚至建议在编 码开始之前，用户文档就已经基本编写完成，这需要 文档工程师在文档管理方面有更专业的素质。 用户教育文档 客户支持文档 开发文档 ;用户教育文档： 　 用户教育文档用于帮助用户认识产品，提供足够的指