卷号 卷内编号
密
分类:
<指南> 使用者:
<项目组> 文档编号：
级
软件开发文档命名约定
Version 1.1
作者：许强
文档信息 标题:软件开发文档命名约定 作者:许强 创建日期: 2005-1-15 上次更新日期: 2005-1-15 版本:1.1 部门名称: 软件实训第一组
修订文档历史记录 日期 2005-1-15 2005-1-17 2005-1-17
版本 1.0 1.1 2.0 说明 创建 增加文档信息和修订文档历史记录的内容 应SQA的要求，更改了SQA文档的命名规范 作者 许强 许强 许强
目 录
1. 2. 3. 4.
目的 …………………………………………………………………………………1 范围 …………………………………………………………………………………1 定义 …………………………………………………………………………………1 文档分类及其命名约定 …………………………………………………………1
4.1 组织过程管理 ........................................................................................................................................ 1 4.1.1 立项 ................................................................................................................................................ 1 4.1.2 阶段评审 ........................................................................................................................................ 1 4.1.3 变更控制 ........................................................................................................................................ 1 4.1.4 结项 ................................................................................................................................................ 1 4.2 项目管理 ................................................................................................................................................ 1 4.2.1 计划与控制 .................................................................................................................................... 1 4.2.2 配置管理 ........................................................................................................................................ 2 4.3 项目开发 ................................................................................................................................................ 2 4.3.1 需求开发 ........................................................................................................................................ 2 4.3.2 分析设计 ........................................................................................................................................ 2 4.3.3 编码 ................................................................................................................................................ 2 4.3.4 单元集成测试 ................................................................................................................................ 2 4.3.5 部署 ................................................................................................................................................ 2 4.4 质量管理 ................................................................................................................................................ 2 4.4.1 过程和产品质量保证 .................................................................................................................... 2 4.4.2 同行评审 ........................................................................................................................................ 2 4.4.3 验收测试 ........................................................................................................................................ 3 4.5 项目考核记录 ........................................................................................................................................ 3
软件开发文档命名约定
1.
目的
本规范描述了软件实训第一组软件开发过程中产生的各种文档的命名约定，用以规范软件项目开发过程中的文档命名。
2.
范围
本规范适用于软件实训第一组在技术委员会立项的所有软件类项目。
3. 定义
SQA：软件质量保证
项目简称：是指项目组对项目的约定的一个统一的简称； 文档主题：是文档主要内容的一个描述。
4. 文档分类及其命名约定
本约定所涉及的文档包括项目开发文档、SQA文档、验收测试文档等， 以下提到的文档交验人是指将文档提交到组织管理配置库中的人。 下面就这些文档分别描述。
4.1 组织过程管理
4.1.1 立项
文档交验人：项目配置经理；
文档交验时间：项目立项成功后一周内；
命名约定：项目简称-文档主题，如（CCES-项目审批表）。
4.1.2 阶段评审
文档交验人：阶段评审组织者； 文档交验时间：阶段评审后两天内；
命名约定：项目简称-文档主题，如（CCES-需求概要详细阶段状态报告）。
4.1.3 变更控制
文档交验人：项目配置经理；
文档交验时间：变更得到批准后两天内；
命名约定：项目简称-文档主题xxxx-xx-xx，如（CCES- xxx变更申请表2005-01-13）。4.1.4 结项
文档交验人：项目配置经理；
文档交验时间：项目完成结项手续前；
命名约定：项目简称-文档主题，如（CCES-项目开发总结报告）。
4.2 项目管理
4.2.1 计划与控制
文档交验人：项目配置经理；
1
软件开发文档命名约定
文档交验时间：计划通过评审后一天内；每周例会后一天内； 命名约定：项目简称-文档主题，如（CCES-概要阶段状态报告），
或项目简称-文档主题xxxx-xx-xx，如（CCES -周例会纪要2005-01-13）。
4.2.2 配置管理
配置管理得工作产品可以糅合在项目开发计划中，因此，可能没有特别文档；
4.3 项目开发
4.3.1 需求开发
文档交验人：项目配置经理；
文档交验时间：工作产品通过评审后两天内；
命名约定：项目简称-文档主题，如（CCES -需求规格说明书）。
4.3.2 分析设计
文档交验人：项目配置经理；
文档交验时间：工作产品通过评审后两天内；
命名约定：项目简称-文档主题，如（CCES -概要规格说明书）。
4.3.3 编码
文档交验人：项目配置经理；
文档交验时间：工作产品通过评审后两天内；
命名约定：项目简称-文档主题，如（CCES -模块开发卷宗）。
4.3.4 单元集成测试
文档交验人：项目配置经理；
文档交验时间：工作产品通过评审后两天内；
命名约定：项目简称-文档主题，如（CCES -系统测试用例）。
4.3.5 部署
文档交验人：项目配置经理；
文档交验时间：工作产品通过评审后两天内；
命名约定：项目简称-文档主题，如（CCES -用户手册）。
4.4 质量管理
4.4.1 过程和产品质量保证
文档交验人：项目SQA负责（接口）人员； 文档交验时间：工作产品通过认可后两天内；
命名约定：SQA-项目简称-文档主题，如（CCES -需求阶段评估报告）。
4.4.2 同行评审
文档交验人：项目配置经理； 文档交验时间：同行评审后两天内；
命名约定：项目简称-文档主题，如（CCES -需求规格说明书同行评审记录）。
2
软件开发文档命名约定 4.4.3 验收测试
文档交验人：项目验收测试负责人； 文档交验时间：测试通过认可后两天内；
命名约定：项目简称-文档主题，如（CCES -系统验收测试）。
4.5 项目考核记录
文档交验人：项目SQA负责（接口）人员； 文档交验时间：考核通告公布后一天内；
命名约定：项目简称-文档主题，如（CCES -项目考核记录表）。
3