3强烈推荐.软件开发文档管理规范强烈推荐.ppt

精选 课件 精选 课件 精选 课件 软件项目管理培训讲座 系列之三——文档管理规范 ., * 内容提要 文档的分类和等级 文档管理的原则和方法 文档示例与讨论 ., * 为什么需要文档管理？ 项目管理的依据 了解进度、分析问题，提供项目可预见性 工作交流的凭证 口说无凭，立字为据 软件测试的基础 没有文档，测试人员无法展开工作 培训用户的参考 帮助外界人员了解项目内幕 技术支持的帮手 帮助技术支持人员熟悉系统、分析错误、解决问题 记录历史的必须 软件最大的价值在于可复用性 ., * 为什么需要文档管理？ ., * 按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。 编写文档的基本思路 明确文档范围，避免空泛浮躁 大而全的文档是没有用的 定位读者角度，防止对牛弹琴 以读者能够理解作为编写文档的标准 规范名词称谓，保持前后一致 统一的名词和称谓，会降低文档的歧义性 注重版本控制，切忌顾此失彼 不同阶段的文档记录了项目开发的完整过程 应用图文表格，保证内容清晰 简洁的图形和表格胜过前言万语 ., * 文档的分类（1） 　 类型 读者 时间 　 可行性研究报告 管理/研发人员 可行性研究与计划阶段 　 项目开发计划 管理/研发人员 可行性研究、需求分析阶段 设 需求规格说明书 研发人员 需求分析阶段 计 功能规格说明书 研发人员 需求分析阶段 开 概要设计说明书 研发/维护人员 设计阶段 发 详细设计说明书 研发/维护人员 设计阶段 类 数据库设计说明书 研发/维护人员 设计阶段 　 模块开发卷宗 管理/研发/维护人员 实现、测试阶段 　 测试计划 研发人员 需求分析、设计阶段 　 测试分析报告 研发/维护人员 测试阶段 管 开发进度月报 管理人员 贯穿整个开发过程 理 项目开发总结 管理人员 测试阶段 类 职责定义 管理人员 可行性研究与计划阶段 　 进度变更记录 管理人员 随时　 产 用户指南 用户 需求分析、设计、实现阶段 品 操作手册 用户 设计、实现阶段 类 信息广告 用户 测试阶段 ., * 文档的分类（2） 文件 阶段 可行性研究 与计划阶段 需求分 析阶段 设计 阶段 实现 阶段 测试 阶段 运行与 维护阶段 数据需求说明书 　 　 　 　 　 　 项目开发计划 　 　 　 　 　 　 软件需求说明书 　 　 　 　 　 　 数据需求说明书 　 　 　 　 　 　 测试计划 　 　 　 　 　 　 概要设计说明书 　 　 　 　 　 　 详细设计说明书 　 　 　 　 　 　 数据库设计说明书 　 　 　 　 　 　 模块开发卷宗 　 　 　 　 　 　 用户手册 　 　 　 　 　 　 操作手册 　 　 　 　 　 　 测试分析报告 　 　 　 　 　 　 开发进度月报 　 　 　 　 　 　 项目开发总结 　 　 　 　 　 　 ., * 文档的分类（3） ., * 开发文档 可行性研究报告 项目开发计划 模块开发卷宗 测试分析报告 需求规格说明书 功能规格说明书 概要设计说明书 详细设计说明书 数据库设计说明书 测试计划 文档的分类（4） ., * 产品文档 用户指南 操作手册 用户指南 产品手册 文档的分类（5） ., * 管理文档 开发进度月报 项目开发总结 职责定义 进度变更记录 文档的等级（1） 确定文档质量等级 根据项目资源、项目大小和风险确定每个文档的格式及详细程度 文档格式和文档内容同样重要 必须保证文档的质量，文档管理才有意义 ., * 文档的等级（2） 文档按照质量可划分为四个等级： 最低限度文档（1级文档） 适合开发工作量低于一个人月的开发者自用程序 包含程序清单、开发记录、测试数据和程序简介 内部文档（2级文档） 适合于没有与其他用户共享资源的专用程序 1级文档内容，加上足够的注释和说明 ., * 文档的等级（3） 文档按照质量可划分为四个等级： 工作文档（3级文档） 适合于由同一单位内若干人联合开发的程序，或可被其他单位使用的程序 正式文档（4级文档） 适合那些要正式发行供普遍使用的软件产品 关键性程序或具有重复管理应用性质（如工资计算）的程序需要4级文档 ., * 内容提要 文档的分类和等级 文档管理的原则和方法 文档示例与讨论 ., * 文档管理的基本原则 完整性原则 项目文档集应覆盖软件开发的完整流程 简洁性原则 编写文档不应浪费过多的时间和经历 有效性原则 文档必须能够起到辅助决策、指导参考的作用 延续性原则 文档的变化必须有合理依据，保持连续发展 ., * 文档管理的内容 建立文档规范，培养良好习惯 制定编写计划，明确编写责任 检查文档质量，提高利用效率 控制文档范围，保护知识产权 实施版本控