文档命名公约

文档命名公约

---

goto推荐 [2005-6-6]
出处：internet
作者：未知

 

 

项目中涉及到的所有文档可以被命名为 <项目名称>_项目名称/项目版本编号>_相应工作过程名称>_文档版本编号>等样式。例如：

Pt_Louise_ModuleA_SRS_1.1.doc
Pt_v1_ModuleA_SPP_0.1.doc
Pt_ModuleA_SCM_1.doc
Pt_ModuleA_SQA_2.1.doc
Pt_ModuleA_Functional Specification_1.doc
Pt_ModuleA_Detail Level Design_1.doc

下划连线“_”用来分开各名称域，但它不是必需的。

相应工作过程名称的简称（例如 SPP，SRS）也不是必需的，但如果要使用，应该遵守下面表格中的标准。

软件构成设计文档 （Component Design Document） CDD
具体设计文档 （Detail Design Document） DDD
软件功能设计文档 （Functional Design Document） FDD
软件功能说明书 （Functional Specification） FS
手册 （Handbook） HB
系统集成测试计划 （Integration Test Plan） ITestPlan
系统集成测试报告 （Integration Test Report） ITestRep
组间协作文档 （Intergroup Coordination Document） IC
初步设计文档 （Preliminary Design Document） PDD
软件配置管理文档 （Software Configuration Management Plan） SCM
软件开发策划文档 （Software Development Plan） SDP
软件项目策划文档 （Software Project Plan） SPP
软件质量保证计划 （Software Quality Assurance Plan） SQA
软件需求规格说明 （Software Requirements Specification） SRS
工作说明 （Statement of Work） SOW
子系统测试计划 （Sub-System Test Plan） SSTP
子系统测试报告 （Sub-System Test Report） SSTR
子系统测试脚本 （Sub-System Test Script） SSTS
软件维护计划 （Sustaining Plan） SP
系统操作描述 （System Operations Description） SOD
系统测试计划 （System Test Plan） STestPlan
系统测试报告 （System Test Report） STestRep
培训计划 （Training Plan） TP

验收测试计划 （Acceptance Test Plan） ATP
验收测试报告 （Acceptance Test Report） ATR
技能评估表格 （Assessment Skills Form） Askills
检查单 （Checklist） CL
程序修改报告 （Code Difference Report） CDR

文档版本编号
下面是对文档版本进行编号要遵守的标准：

起草版本的编号为 0.1, 0.2, 0.3, ..., 0.10.

版本编号可以根据项目需要延伸到若干层，例如， 0.1, 0.1.1, 0.1.1.1.

一旦文档版本得以确认后，可以正式发布，则其版本编号应该始自 1.0。版本编号不断变化为： 1.0, 1.1, 1.2, ..., 1.10.

项目可以根据需要（如基线、工程等）将版本编号晋升为2.0，2.1, 2.2 等。