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

转载,很好的学习材料

软件项目管理培训讲座系列之三——文档管理规范

转载,很好的学习材料

内容提要文档的分类和等级文档管理的原则和方法 文档示例与讨论

2013年12月30日

软件项目管理培训之三——文档规范

转载,很好的学习材料

为什么需要文档管理？项目管理的依据了解进度、分析问题，提供项目可预见性

工作交流的凭证口说无凭，立字为据

软件测试的基础没有文档，测试人员无法展开工作

培训用户的参考帮助外界人员了解项目内幕

技术支持的帮手帮助技术支持人员熟悉系统、分析错误、解决问题

记录历史的必须软件最大的价值在于可复用性2013年12月30日 软件项目管理培训之三——文档规范 3

转载,很好的学习材料

为什么需要文档管理？

按规范要求生成一整套文档的 过程，就是按照软件开发规范 完成一个软件开发的过程。

2013年12月30日

软件项目管理培训之三——文档规范

转载,很好的学习材料

编写文档的基本思路明确文档范围，避免空泛浮躁大而全的文档是没有用的

定位读者角度，防止对牛弹琴以读者能够理解作为编写文档的标准

规范名词称谓，保持前后一致统一的名词和称谓，会降低文档的歧义性

注重版本控制，切忌顾此失彼不同阶段的文档记录了项目开发的完整过程

应用图文表格，保证内容清晰简洁的图形和表格胜过前言万语2013年12月30日 软件项目管理培训之三——文档规范 5

转载,很好的学习材料

文档的分类(1)类型可行性研究报告 项目开发计划 设 计 需求规格说明书 功能规格说明书

读者管理/研发人员 管理/研发人员 研发人员 研发人员

时间可行性研究与计划阶段 可行性研究、需求分析阶段 需求分析阶段 需求分析阶段

开发 类

概要设计说明书详细设计说明书 数据库设计说明书 模块开发卷宗 测试计划 测试分析报告

研发/维护人员研发/维护人员 研发/维护人员 管理/研发/维护人员 研发人员 研发/维护人员 管理人员 管理人员

设计阶段设计阶段 设计阶段 实现、测试阶段 需求分析、设计阶段 测试阶段 贯穿整个开发过程 测试阶段

管 理 类

开发进度月报 项目开发总结

职责定义 进度变更记录用户指南 操作手册

管理人员 管理人员用户 用户

可行性研究与计划阶段 随时需求分析、设计、实现阶段 设计、实现阶段

产 品 类

信息广告

用户

测试阶段

2013年12月30日

软件项目管理培训之三——文档规范

转载,很好的学习材料

文档的分类(2)文件 数据需求说明书 项目开发计划 软件需求说明书 数据需求说明书 测试计划 概要设计说明书 详细设计说明书 数据库设计说明书 阶段 可行性研究 与计划阶段 需求分 析阶段 设计 阶段 实现 阶段 测试 阶段 运行与 维护阶段

模块开发卷宗用户手册 操作手册 测试分析报

告 开发进度月报

项目开发总结

2013年12月30日

软件项目管理培训之三——文档规范

转载,很好的学习材料

文档的分类(3)开发文档

可 行 性 研 究 报 告

项 目 开 发 计 划

需 求 规 格 说 明 书

功 能 规 格 说 明 书

概 要 设 计 说 明 书

详 细 设 计 说 明 书

数 据 库 设 计 说 明 书

模 块 开 发 卷 宗

测 试 计 划

测 试 分 析 报 告

2013年12月30日

软件项目管理培训之三——文档规范

转载,很好的学习材料

文档的分类(4)

产品文档

用户指南

操作手册

产品手册

用户指南

2013年12月30日

软件项目管理培训之三——文档规范

转载,很好的学习材料

文档的分类(5)

管理文档

开发进度月报

项目开发总结

进度变更记录

职责定义

2013年12月30日

软件项目管理培训之三——文档规范

转载,很好的学习材料

文档的等级(1)确定文档质量等级根据项目资源、项目大小和风险确定每个文档 的格式及详细程度 文档格式和文档内容同样重要 必须保证文档的质量，文档管理才有意义

2013年12月30日

软件项目管理培训之三——文档规范

转载,很好的学习材料

文档的等级(2)文档按照质量可划分为四个等级：最低限度文档(1级文档)适合开发工作量低于一个人月的开发者自用程序 包含程序清单、开发记录、测试数据和程序简介

内部文档(2级文档)适合于没有与其他用户共享资源的专用程序 1级文档内容，加上足够的注释和说明

2013年12月30日

软件项目管理培训之三——文档规范

转载,很好的学习材料

文档的等级(3)文档按照质量可划分为四个等级：工作文档(3级文档)适合于由同一单位内若干人联合开发的程序，或 可被其他单位使用的程序

正式文档(4级文档)适合那些要正式发行供普遍使用的软件产品 关键性程序或具有重复管理应用性质(如工资计 算)的程序需要4级文档

2013年12月30日

软件项目管理培训之三——文档规范

转载,很好的学习材料

内容提要文档的分类和等级文档管理的原则和方法 文档示例与讨论

2013年12月30日

软件项目管理培训之三——文档规范

转载,很好的学习材料

文档管理的基本原则完整性原则项目文档集应覆盖软件开发的完整流程

简洁性原则编写文档不应浪费过多的时间和经历

有效性原则文档必须能够起到辅助决策、指导参考的作用

延续性原则文档的变化必须有合理依据，保持连续发展

2013年12月30日

软件项目管理培训之三——文档规范

转载,很好的学习材料

文档管理的内容建立文档规范，培养良好习惯制定编写计划，明确编写责任 检查文档质量，提高利用效率 控制文档范围，保护知识产权 实施版本控制，有效记录历史2013年12月30日 软件项目管理培训之三——文档规范 16