软件开发文档管理规范

《软件开发文档管理规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、软件项目管理培训讲座系列之三——文档管理规范内容提要文档的分类和等级文档管理的原则和方法文档示例与讨论7/23/20212软件项目管理培训之三——文档规范为什么需要文档管理？项目管理的依据了解进度、分析问题，提供项目可预见性工作交流的凭证口说无凭，立字为据软件测试的基础没有文档，测试人员无法展开工作培训用户的参考帮助外界人员了解项目内幕技术支持的帮手帮助技术支持人员熟悉系统、分析错误、解决问题记录历史的必须软件最大的价值在于可复用性7/23/20213软件项目管理培训之三——文档规范为什么需要文档管理？按规

2、范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。7/23/20214软件项目管理培训之三——文档规范编写文档的基本思路明确文档范围，避免空泛浮躁大而全的文档是没有用的定位读者角度，防止对牛弹琴以读者能够理解作为编写文档的标准规范名词称谓，保持前后一致统一的名词和称谓，会降低文档的歧义性注重版本控制，切忌顾此失彼不同阶段的文档记录了项目开发的完整过程应用图文表格，保证内容清晰简洁的图形和表格胜过前言万语7/23/20215软件项目管理培训之三——文档规范文档的分类（1）类型读者时间可行

3、性研究报告管理/研发人员可行性研究与计划阶段项目开发计划管理/研发人员可行性研究、需求分析阶段设需求规格说明书研发人员需求分析阶段计功能规格说明书研发人员需求分析阶段开概要设计说明书研发/维护人员设计阶段发详细设计说明书研发/维护人员设计阶段类数据库设计说明书研发/维护人员设计阶段模块开发卷宗管理/研发/维护人员实现、测试阶段测试计划研发人员需求分析、设计阶段测试分析报告研发/维护人员测试阶段管开发进度月报管理人员贯穿整个开发过程理项目开发总结管理人员测试阶段类职责定义管理人员可行性研究与计划阶段进度变更记

4、录管理人员随时产用户指南用户需求分析、设计、实现阶段品操作手册用户设计、实现阶段类信息广告用户测试阶段7/23/20216软件项目管理培训之三——文档规范文档的分类（2）文件阶段可行性研究与计划阶段需求分析阶段设计阶段实现阶段测试阶段运行与维护阶段数据需求说明书项目开发计划软件需求说明书数据需求说明书测试计划概要设计说明书详细设计说明书数据库设计说明书模块开发卷宗用户手册操作手册测试分析报告开发进度月报项目开发总结7/23/20217软件项目管理培训之三——文档规范文档的分类（3）开发文档可行性研究报告项目

5、开发计划模块开发卷宗测试分析报告需求规格说明书功能规格说明书概要设计说明书详细设计说明书数据库设计说明书测试计划7/23/20218软件项目管理培训之三——文档规范文档的分类（4）产品文档用户指南操作手册用户指南产品手册7/23/20219软件项目管理培训之三——文档规范文档的分类（5）管理文档开发进度月报项目开发总结职责定义进度变更记录7/23/202110软件项目管理培训之三——文档规范文档的等级（1）确定文档质量等级根据项目资源、项目大小和风险确定每个文档的格式及详细程度文档格式和文档内容同样重要必须

6、保证文档的质量，文档管理才有意义7/23/202111软件项目管理培训之三——文档规范文档的等级（2）文档按照质量可划分为四个等级：最低限度文档（1级文档）适合开发工作量低于一个人月的开发者自用程序包含程序清单、开发记录、测试数据和程序简介内部文档（2级文档）适合于没有与其他用户共享资源的专用程序1级文档内容，加上足够的注释和说明7/23/202112软件项目管理培训之三——文档规范文档的等级（3）文档按照质量可划分为四个等级：工作文档（3级文档）适合于由同一单位内若干人联合开发的程序，或可被其他单位使用的

7、程序正式文档（4级文档）适合那些要正式发行供普遍使用的软件产品关键性程序或具有重复管理应用性质（如工资计算）的程序需要4级文档7/23/202113软件项目管理培训之三——文档规范内容提要文档的分类和等级文档管理的原则和方法文档示例与讨论7/23/202114软件项目管理培训之三——文档规范文档管理的基本原则完整性原则项目文档集应覆盖软件开发的完整流程简洁性原则编写文档不应浪费过多的时间和经历有效性原则文档必须能够起到辅助决策、指导参考的作用延续性原则文档的变化必须有合理依据，保持连续发展7/23/2021

8、15软件项目管理培训之三——文档规范文档管理的内容建立文档规范，培养良好习惯制定编写计划，明确编写责任检查文档质量，提高利用效率控制文档范围，保护知识产权实施版本控制，有效记录历史7/23/202116软件项目管理培训之三——文档规范文档管理方法：如何命名？命名规范的重要性统一的对外形象（举例）有效的文档分类（举例）快速的文档查找（举例）命名规则的制定并无统一规则，依据项目环境自定义技巧1：确定统一的空白封面和项