文档控制规范.doc

耀邦软件规范 文档管理规范 版本 2 2 配置管理 文档类别 耀邦软件规范 文档名称 文档管理规范 文档标识 ybsw doc 版本 2 2 状态 草稿 访问路径 ybsw vob tech 模板 ybsw tmpl word dot v1 0 所有人 SEPG 作者 创建时间 2005 11 28 批准人 批准时间 修订历史 日期 版本 说明 作者 2005 11 12 1 0 1 列出已识别的文档清单及其代码 2 定义文档的标识规则 3 给出一般文档的格式规范 2005 11 19 1 1 1 重新细化分类所有文档 对命名方式无影响 2 添加周报命名方式 3 添加红色字体的注释信息 2005 11 21 1 2 1 取消文件名中的版本号 2 增加 任务单 业务分析规格说明书 和 系统部署文档 的标识 3 文件名中添加 文档类别 项 4 增加无版本文档的标识规范 5 增加文档命名的样例 2005 11 22 1 3 1 增加对文档修订的规定 2 用蓝色字体标识本次修改的部分 2005 11 23 1 4 修订版本号标识规则 2005 11 23 2 0 正式发布 2 0 版 2005 11 26 2 1 修订一处微小错误 2005 11 28 2 2 1 修改 SCM 审计报告的代码 2 增加 参考编码规则 3 改 变更请求 为 变更申请 目录 1 简介 5 1 1 目的 5 1 2 范围 5 1 3 读者 5 2 文档类别 5 3 文档清单 5 4 文档标识 8 4 1 带版本文档 8 4 1 1 标识号 ID 8 4 1 2 版本号 9 4 2 无版本文档 9 4 2 1 项目文档 9 4 2 2 员工周报 10 5 文档格式 10 6 文档修订 11 文档管理 1 简介 1 1 目的 编制本文档的目的在于为所有的项目文档的命名 编码以及版本号的确定建立一套统一的规 则和方法 以唯一地确定项目的每一产出物 1 2 范围 本文档仅描述项目级文档的管理规则 不包括公司级文档 1 3 读者 所有软件工程人员应该阅读本文档 并遵从本文档的规则识别项目中产生的文档 并对其进 行标识以及按照规范的格式撰写文档 2 文档类别 类别 说明 代码 管理类 各种有关项目策划 度量 跟踪 调整的文档 MNG 需求类 各种与业务和需求相关的文档 模型 REQ 设计类 各种设计文档 模型等 DSN 实施类 与软件开发和集成相关的文档 IMP 测试类 测试相关文档 数据等 TST 发布类 发布声明以及各种用户文档 REL SCM 类 SCM 系统相关文档及 SCM 报告 SCM SQA 类 SQA 计划及报告 SQA 参考资料类 各种参考资料 REF 3 文档清单 序号 文档中文名称 文档英文名称 文档代码 模板 评审级别 管理类 MNG 1 立项申请 Project Establish Request PER 组织级 2 项目任务书 Statement of Work SOW 组织级 3 软件开发计划 Software Development Plan SDP ybsw tmpl mng sdp dot 组织级 4 软件开发日程 表 Software Development Schedule SDS 组织级 5 软件维护计划 Software Maintainance Plan SMP 组织级 6 任务单 Task Form TASK 7 项目度量报告 Project Measurement Report PMR 8 项目跟踪报告 Project Tracking Report PTR 9 项目总结报告 Project Summary Report PSR 组织级 需求类 REQ 1 可行性分析报 告 Feasibility Analysis Report FAR 组织级 2 业务分析规格 说明书 Business Analysis Specification BAS 组织级 3 前景与范围 Vision and Scope VNS 组织级 4 软件需求规格 说明书 Software Requirment Specification SRS ybsw tmpl req srs dot 组织级 设计类 DSN 1 总体设计说明 书 General Design Specification GDS 项目级 2 数据库设计说 明书 Database Design Specification DBDS 项目级 3 用户界面设计 说明书 User Interface Design Specification UIDS 项目级 4 接口设计说明 书 Interface Design Specification IDS 项目级 5 详细设计说明 书 Detailed Design Specification DDS 项目级 实施类 IMP 1 软件配置清单 Software Configuration List SCL 项目级 2 软件开发文件 Software Development File SDF 项目级 3 系统部署文档 System Deployment Document SDD 项目级 测试类 TST 1 单元测试用例 Unit Test Case UTC 2 单元测试数据 Unit Test Data UTD 3 单元测试脚本 Unit Test Script UTS 4 单元测试报告 Unit Test Report UTR 项目级 5 集成测试用例 Integration Test Case ITC 6 集成测试数据 Integration Test Data ITD 7 集成测试脚本 Integration Test Script ITS 8 集成测试报告 Integration Test Report ITR 项目级 9 系统测试用例 System Test Case STC 10 系统测试数据 System Test Data STD 11 系统测试脚本 System Test Script STS 12 系统测试报告 System Test Report STR 组织级 发布类 REL 1 产品技术白皮 书 Product Technical Whitepaper PTW 组织级 2 系统安装手册 System Installation Manual SIM 组织级 3 用户操作手册 User Operation Manual UOM 组织级 4 产品维护手册 Product Maintainance Manual PMM 组织级 5 产品培训资料 Product Training Materials PTM 组织级 6 产品发布声明 Product Release Note PRN 组织级 SCM 类 SCM 1 建库申请表 System Request Form RF ybsw tmpl scm srf dot 项目级 2 建库验证报告 System Verify Report VR 3 SCM 审计报告 SCM Audit Report AR 4 变更申请表 Change Request CR 项目级 SQA 类 SQA 1 SQA 报告 SQA Report RPT 2 SQA 问题报告 Issue Report IR 其它 1 评审报告 Review Report RR ybsw tmpl rr dot 2 员工周报 Weekly Report WR ybsw tmpl wr xls 对于以上文档清单中未列出的文档 可参考以下编码规则以确定其代码 参考编码规则 中文名称 英文名称 代码 中文名称 英文名称 代码 计划 Plan PLN 样例 Sample SMPL 模型 Model MDL 文档 Document DOC 数据 Data DATA 工具 Tool TOOL 脚本 Script SCRP 报告 Report RPT 问题 Issue ISS 参考资料 Reference REF 4 文档标识 4 1 带版本文档 带版本文档指的是有版本修订 演进过程的文档 项目中绝大部分管理文档和技术文档 第 三节的文档清单中以黑色字体标识 都是带版本的 4 1 1 标识号 ID 文档的标识号用于命名文档 同时写入文档的配置管理页与页眉中 带版本文档的标识号形式为 项目 产品英文简称 系统 子系统 组件代码 文档类别 文档代码 其中 项目 产品英文简称 项目 产品立项时确定的英文名称缩写 如 OBS 1 0 系统 子系统 组件代码 系统 子系统 组件代码用于标识文档的级别或其所属的子系统 组件 对于系统级文档 该代码为 SYS 对于子系统 组件级文档 该代码为子系统 组件代码 子系统 组件由项目经理在总体设计完成之前确定 并写入总体设计规格说明书 文档类别 本文档第二节确定的文档类别 文档代码 本文档第三节确定的文档代码 若有本文档中未识别出来的文档 请及时通 知您的 SQA 工程师以获得帮助 如果同类文档有多个 可以在本节加上两位数的编码 样例 OBS 1 0 SYS MNG SDS 为 OBS 系统 1 0 版的软件开发日程表 OBS 1 0 SYS DSN MOD 为系统设计模型 OBS 1 0 JSP DSN DDS 为 JSP 组件的详细设计规格说明书 OBS 1 0 JSP TST UTR 为 JSP 组件的单元测试报告 OBS 1 0 SYS TST ITD01 为集成测试的第一组测试数据 4 1 2 版本号 版本号形式为 x y 其中 y 表示文档修订的次数 x 表示文档发布的次数 文档初始版本号为 0 1 以后每产生一次修订 y 1 第一次发布的正式版版本号为 1 0 以后每产生一次修订 y 1 重新评审和发布 x 1 4 2 无版本文档 无版本文档指的是由项目当前状态评估而产生的各种文档 如评审报告 SCM 报告 SQA 报 告等各种报告以及任务单 变更请求表等表单 在第三节的文档清单中以灰色字体标识 4 2 1 项目文档 项目中无版本文档的标识号形式为 项目 产品英文简称 系统 子系统 组件代码 文档类别 文档代码 日期 编码 其中 项目 产品英文简称 项目 产品立项时确定的英文名称缩写 如 OBS 1 0 系统 子系统 组件代码 系统 子系统 组件代码用于标识文档的级别或其所属的子系统 组件 对于系统级文档 该代码为 SYS 对于子系统 组件级文档 该代码为子系统 组件代码 子系统 组件由项目经理在总体设计完成之前确定 并写入总体设计规格说明书 文档类别 本文档第二节确定的文档类别 文档代码 本文档第三节确定的文档代码 若有本文档中未识别出来的文档 请及时通 知您的 SQA 工程师以获得帮助 日期 编码 对于各种报告规定为报告的日期 形式为 YYYYMMDD 对于各种表单则 为 3 位数的流水号 样例 OBS 1 0 SYS REQ RR 20011121 为 2001 年 11 月 21 日需求评审的报告 OBS 1 0 JSP DSN RR 20011121 为 2001 年 11 月 21 日 JSP 组件详细设计评审的报告 OBS 1 0 SYS SQA IR 20011123 为 2001 年 11 月 23 日的 SQA 问题报告 OBS 1 0 SYS SCM CR 001 为项目的第一个变更请求 4 2 2 员工周报 员工周报命名方式为 WR NAME 日期 其中 NAME 公司统一的 Email 帐号 日期 项目规定的报告日期 形式为 YYYYMMDD 样例 WR LIJUAN 20011121 5 文档格式 文档的格式包括 文档封面 页眉和页脚 目录 正文 10 页以上的文档必须有目录 标题与字体格式 配置管理页 所有带版本的文档必须有配置管理页 评审记录 需要评审的文档应附评审及批准的记录 无特殊情况文档均采用 Microsoft Word 2000 进行编辑 整体格式见 Word 文档模板 ybsw tmpl word dot 6 文档修订 每次修订文档应填写配置管理页中的 修订历史 每次修订的内容应以蓝色字体标识 评审记录 评审要求 本文档需要组织级评审 参加评审的人包括 SEPG 以及主管技术的高级经理 必须由 SEPG 组长 质量经理和高级经理共同签字批准才能生效 批准人 姓名 职务 签名 时间