敏捷开发的技术文档管理

许多团队或个人都有一个观念是敏捷开发应该弱化技术文档管理，以达到敏捷的目的。其实不然，敏捷开发只是把开发的生命周期变成不断迭代的软件开发过程，在迭代的过程中应该包含了技术文档的整理完善，使其可以为下一个迭代做准备。而且，建立完备、便于理解并与代码配对的技术文档是软件工程师的基本素质。 这种素质是独立的，不随软件开发方法的改变而改变的要求。

下面分享一些敏捷开发的技术文档管理实战经验，这些经验能驱动团队建立相对完善的技术文档。

• 建立任务(Ticket)的书写框架 - 建立Ticket的书写框架，以保证覆盖需求的必要信息。如：Story必须有背景(Background), 描述(Description)和验收标准(Acceptance Criteria)。
• 代码分支(Branch)和代码提交(Commit)必须与任务(Ticket)关联 - 工程师接到任务并建立Branch开始开发的时候，Branch名必须以Ticket代号为开头，如：ABC-1234-xxxxyyyzzz。在Commit的时候，提交标题也必须以Ticket代号为开头，并在提交中尽可能详细的描述提交的内容。这样可以最直观的关联代码与Ticket之间的关系，知道代码为什么而改。
• 设计文档应单独建立任务(Ticket) - 设计文档应单独建立Ticket。至少在总体设计时应该这么做。设计文档一般由架构师，技术经理，或技术负责人建立，并保存在项目的文档中，如Confluence或Wiki。文档应由开发团队审查并确认，由此确认开发的方向。设计文档视项目的进程可以加入迭代的过程。
• 善用README和注释Comment，并加入同行评议(Peer review) - 软件工程师应该养成良好的注释代码(Comment)的习惯，在添加或修改代码的时候添加注释。另外，可以利用README作为设计文档的补充，添加详细的设计思路。这些最佳实践可以通过Peer review建立良性的文档习惯，通过Peer review让评议者保证代码和文档可理解性。

良好的技术文档管理可以提高代码的质量，可读性和可延续性。可以减少团队对某一成员的依赖，也减轻了某一成员与一个系统的耦合度。为团队的扩大和增长提供良好的基础。