研发文档管理规范

文档管理规范文档管理规范 版本 1.0 修订记录 初稿 修正 审核 批准 版权所有侵权必究 目录 1.简介 3 1.1目的 3 1.2范围 3 1.3读者 3 2.文档类别 3 3.文档清单 3 日期 日期 日期 日期 2012-6-15 深圳恒飞盈通科技有限公司 4.文档标识 6 4.1带版本文档 6 4.1.1标识号（ID） 6 4.1.2版本号 7 4.2无版本文档 7 4.2.1项目文档 7 4.2.2员工周报 8 5.文档格式 9 6.文档修订 9 文档管理 简介简介 目的目的 编制本文档的目的在于为所有的项目文档的命名、编码以及版本号的确定建 立一套统一的规则和方法，以唯一地确定项目的每一产出物。 范围范围 本文档仅描述项目级文档的管理规则，不包括公司级文档。 读者读者 所有软件工程人员应该阅读本文档，并遵从本文档的规则识别项目中产生的 文档，并对其进行标识以及按照规范的格式撰写文档。 文档类别文档类别 类别 管理类 需求类 设计类 实施类 测试类 发布类 参考资料类 说明 各种有关项目策划、度量、跟踪、调整的文档 各种与业务和需求相关的文档、模型 各种设计文档、模型等 与软件开发和集成相关的文档 测试相关文档、数据等 发布声明以及各种用户文档 各种参考资料 代码 MNG REQ DSN IMP TST REL REF 文档清单文档清单 序 号 文档中文名称文档英文名称 文档代模 码 评审级 板别 管理类（MNG） 1 2 3 4 5 6 立项申请 项目任务书 软件开发计划 Project Establish Request Statement of Work Software Development Plan PER SOW SDP SDS SMP TASK / / / / / / 组织级 组织级 组织级 组织级 组织级 / 软件开发日程表Software Development Schedule 软件维护计划 任务单 Software Maintainance Plan Task 7 8 项目跟踪报告 项目总结报告 Project Tracking Report Project Summary Report PTR PSR / / / 组织级 需求类（REQ） 1 2 3 4 可行性分析报告Feasibility Analysis Report 业务分析规格说明 书 前景与范围 FAR/ / / / 组织级 组织级 组织级 组织级 Business Analysis SpecificationBAS Vision and ScopeVNS SRS 软件需求规格说明 Software Requirment 书Specification 设计类（DSN） 1 2 3 4 5 总体设计说明书General Design Specification 数据库设计说明书 Database Design Specification 用户界面设计说明 User Interface Design 书Specification GDS DBDS UIDS / / / / / 项目级 项目级 项目级 项目级 项目级 接口设计说明书Interface Design SpecificationIDS 详细设计说明书Detailed Design SpecificationDDS 实施类（IMP） 1 2 3 软件配置清单 软件开发文件 系统部署文档 Software Configuration List Software Development File System Deployment Document SCL SDF SDD / / / 项目级 项目级 项目级 测试类（TST） 1 2 3 4 5 单元测试用例 单元测试数据 单元测试脚本 单元测试报告 集成测试用例 Unit Test Case Unit Test Data Unit Test Script Unit Test Report Integration Test Case UTC UTD UTS UTR ITC / / / / / / / / 项目级 / 6 7 8 9 集成测试数据 集成测试脚本 集成测试报告 系统测试用例 Integration Test Data Integration Test Script Integration Test Report System Test Case System Test Data System Test Script System Test Report ITD ITS ITR STC STD STS STR / / / / / / / / / 项目级 / / / 组织级 10系统测试数据 11系统测试脚本 12系统测试报告 发布类（REL） 1 2 3 4 5 6 产品技术白皮书Product Technical Whitepaper 系统安装手册 用户操作手册 产品维护手册 产品培训资料 产品发布声明 System Installation Manual User Operation Manual Product Maintainance Manual Product Training Materials Product Release Note PTW SIM UOM PMM PTM PRN / / / / / / 组织级 组织级 组织级 组织级 组织级 组织级 其它 1评审报告Review Report Weekly Report RR WR // 2员工周报 参考编码规则 中文名称 计划 模型 数据 脚本 // 对于以上文档清单中未列出的文档，可参考以下编码规则以确定其代码： 英文名称 Plan Model Data Script 代码 PLN MDL DATA SCRP 中文名称 样例 文档 工具 报告 英文名称 Sample Document Tool Report 代码 SMPL DOC TOOL RPT 问题IssueISS参考资料ReferenceREF 文档标识文档标识 带版本文档带版本文档 带版本文档指的是有版本修订、演进过程的文档，项目中绝大部分管理文档 和技术文档（第三节的文档清单中以黑色字体标识）都是带版本的。 标识号（标识号（IDID）） 文档的标识号用于命名文档，同时写入文档的配置管理页与页眉中。 带版本文档的标识号形式为： [项目/产品英文简称]-[系统/子系统/组件代码]-[文档类别]-[文档代码] 其中： [项目/产品英文简称]：项目/产品立项时确定的英文名称缩写，如 OBS_1.0 [系统/子系统/组件代码]：系统/子系统/组件代码用于标识文档的级别或其 所属的子系统/组件。对于系统级文档，该代码为 SYS；对于子系统/组件级文档， 该代码为子系统/组件代码。子系统/组件由项目经理在总体设计完成之前确定，并 写入总体设计规格说明书 [文档类别]：本文档第二节确定的文档类别 [文档代码]：本文档第三节确定的文档代码，如果同类文档有多个，可以在 本节加上两位数的编码。 样例： OBS_1.0-SYS-MNG-SDS为 OBS 系统