3.软件开发文档管理规范

软件项目管理培训讲座系列之三——文档管理规范内容提要文档的分类和等级文档管理的原则和方法文档示例与讨论2024年9月12日软件项目管理培训之三——文档规范2为什么需要文档管理？项目管理的依据了解进度、分析问题，提供项目可预见性工作交流的凭证口说无凭，立字为据软件测试的基础没有文档，测试人员无法展开工作培训用户的参考帮助外界人员了解项目内幕技术支持的帮手帮助技术支持人员熟悉系统、分析错误、解决问题记录历史的必须软件最大的价值在于可复用性2024年9月12日软件项目管理培训之三——文档规范3为什么需要文档管理？2024年9月12日软件项目管理培训之三——文档规范4按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。编写文档的基本思路明确文档范围，避免空泛浮躁大而全的文档是没有用的定位读者角度，防止对牛弹琴以读者能够理解作为编写文档的标准规范名词称谓，保持前后一致统一的名词和称谓，会降低文档的歧义性注重版本控制，切忌顾此失彼不同阶段的文档记录了项目开发的完整过程应用图文表格，保证内容清晰简洁的图形和表格胜过前言万语2024年9月12日软件项目管理培训之三——文档规范5文档的分类（1）

类型读者时间

可行性研究报告管理/研发人员可行性研究与计划阶段

项目开发计划管理/研发人员可行性研究、需求分析阶段设需求规格说明书研发人员需求分析阶段计功能规格说明书研发人员需求分析阶段开概要设计说明书研发/维护人员设计阶段发详细设计说明书研发/维护人员设计阶段类数据库设计说明书研发/维护人员设计阶段

模块开发卷宗管理/研发/维护人员实现、测试阶段

测试计划研发人员需求分析、设计阶段

测试分析报告研发/维护人员测试阶段管开发进度月报管理人员贯穿整个开发过程理项目开发总结管理人员测试阶段类职责定义管理人员可行性研究与计划阶段

进度变更记录管理人员随时产用户指南用户需求分析、设计、实现阶段品操作手册用户设计、实现阶段类信息广告用户测试阶段2024年9月12日软件项目管理培训之三——文档规范6文档的分类（2）文件阶段可行性研究与计划阶段需求分析阶段设计阶段实现阶段测试阶段运行与维护阶段数据需求说明书

项目开发计划

软件需求说明书

数据需求说明书

测试计划

概要设计说明书

详细设计说明书

数据库设计说明书

模块开发卷宗

用户手册

操作手册

测试分析报告

开发进度月报

项目开发总结

2024年9月12日软件项目管理培训之三——文档规范7文档的分类（3）2024年9月12日软件项目管理培训之三——文档规范8开发文档可行性研究报告项目开发计划模块开发卷宗测试分析报告需求规格说明书功能规格说明书概要设计说明书详细设计说明书数据库设计说明书测试计划文档的分类（4）2024年9月12日软件项目管理培训之三——文档规范9产品文档用户指南操作手册用户指南产品手册文档的分类（5）2024年9月12日软件项目管理培训之三——文档规范10管理文档开发进度月报项目开发总结职责定义进度变更记录文档的等级（1）确定文档质量等级根据项目资源、项目大小和风险确定每个文档的格式及详细程度文档格式和文档内容同样重要必须保证文档的质量，文档管理才有意义2024年9月12日软件项目管理培训之三——文档规范11文档的等级（2）文档按照质量可划分为四个等级：最低限度文档（1级文档）适合开发工作量低于一个人月的开发者自用程序包含程序清单、开发记录、测试数据和程序简介内部文档（2级文档）适合于没有与其他用户共享资源的专用程序1级文档内容，加上足够的注释和说明2024年9月12日软件项目管理培训之三——文档规范12文档的等级（3）文档按照质量可划分为四个等级：工作文档（3级文档）适合于由同一单位内若干人联合开发的程序，或可被其他单位使用的程序正式文档（4级文档）适合那些要正式发行供普遍使用的软件产品关键性程序或具有重复管理应用性质（如工资计算）的程序需要4级文档2024年9月12日软件项目管理培训之三——文档规范13内容提要文档的分类和等级文档管理的原则和方法文档示例与讨论2024年9月12日软件项目管理培训之三——文档规范14文档管理的基本原则完整性原则项目文档集应覆盖软件开发的完整流程简洁性原则编写文档不应浪费过多的时间和经历有效性原则文档必须能够起到辅助决策、指导参考的作用延续性原则文档的变化必须有合理依据，保持连续发展2024年9月12日软件项目管理培训之三——文档规范15文档管理的内容建立文档规范，培养良好习惯制定编写计划，明确编写责任检查文档质量，提高利用效率控制文档范围，保护知识产权实施版本控制，有效记录历史2024年9月12日软件项目管理培训之三——文档规范16文档管理方法：如何命名？命名规范的重要性统一的对外形象（举例）有效的文档分类（举例）快速的文档查找（举例）命名规则的制定并无统一规则，依据项目环境自定义技巧1：确定统一的空白封面和项目名称技巧2：同类型多个文档的命名方法技巧3：文档存储和管理的方法2024年9月12日软件项目管理培训之三——文档规范17文档管理方法：如何保证内容完整？内容残缺的体现缺少项目背景和内容目录（举例）缺少表格和示意图（举例）缺少对思想的阐述和问题的分析（举例）保证内容完整的方法技巧1：提供统一的项目背景资料技巧2：培养一致的文档编写习惯技巧3：明确要求表格和图形的使用方式2024年9月12日软件项目管理培训之三——文档规范18文档管理方法：如何写好需求分析做好需求分析的前提条件客户应用环境的了解市场主流与技术主流的了解客户现有需求的总结和潜在需求的挖掘完成需求分析的过程第一步：项目建议书（Proposal）第二步：市场与技术调研报告（M&TReport)第三步：需求变更风险分析第四步：需求分析初稿2024年9月12日软件项目管理培训之三——文档规范19文档管理方法：如何写好概要设计做好概要设计的前提条件客户需求细节的了解技术重点和难点的分析系统结构的设计与划分完成概要设计的过程第一步：功能描述（FunctionDescription）第二步：功能定义（FunctionSpecification）第三步：重点难点问题解决思路第四步：概要设计草案2024年9月12日软件项目管理培训之三——文档规范20文档管理方法：如何写好详细设计详细设计的底线是什么？主要处理流程的详细说明对外接口的详细说明主要逻辑结构和数据结构的详细说明完成详细设计的过程第一步：流程定义（ControlFlow）第二步：数据结构定义（DataFlow)第三步：接口定义（APISpecification）第四步：详细设计草案2024年9月12日软件项目管理培训之三——文档规范21文档管理方法：如何写好里程碑报告里程碑报告的内容预期目标的解释和说明已完成工作的说明进度情况、测试结果的分析和说明下一步工作的重点和难点完成里程碑报告的过程第一步：分析前一个里程碑报告的内容第二步：说明当前里程碑的主要进展第三步：总结存在的问题、困难和障碍第四步：列出下一个里程碑的主要工作计划2024年9月12日软件项目管理培训之三——文档规范22文档管理方法：确定最小文档集如何确定最小文档集重要认识：最小文档集不是指最简单文档集最重要、最必须的文档组成最小文档集如何实现最小文档集人员分工：多人协作完成一份文档文档格式：提供统一易用的模板内容组织：合并细节结构，保持总体完整2024年9月12日软件项目管理培训之三——文档规范23反思：为什么中国人不善于写文档？文化背景的原因官修史与私修史：从孔子谈起封建专制与思想禁锢：焚书坑儒和文字狱现代教育的原因缺乏方法教育和人格教育缺乏法律意识和严谨态度官本位、钱本位的价值观2024年9月12日软件项目管理培训之三——文档规范24内容提要文档的分类和等级文档管理的原则和方法文档示例与讨论2024年9月12日软件项目管理培训之三——文档规范25文档编写技巧文档排版方法问题：你会用MSWord吗？图表制作方法问题：你会用MSVisio和MSExcel吗？文档分类结构问题：如何设计良好的文件夹结构？文档命名方式问题：如何对自己的项目进行文档命名？2024年9月12日软件项目管理培训之三——文档规范26文档示例与讨论需求分析文档示例研发类项目概要设计与详细设计示例应用类项目概要设计与详细设计示例数据库与数据仓库类设计文档示例测试计划与测试案例类文