研发文档管理规范Word格式.docx
《研发文档管理规范Word格式.docx》由会员分享，可在线阅读，更多相关《研发文档管理规范Word格式.docx（11页珍藏版）》请在冰点文库上搜索。
4.1.1
标识号（ID）
4.1.2
版本号
7
4.2
无版本文档
4.2.1
项目文档
4.2.2
员工周报
8
5.
文档格式
9
6.
文档修订
文档管理
简介
目的
编制本文档的目的在于为所有的项目文档的命名、编码以及版本号的确定建立一套统一的规则和方法，以唯一地确定项目的每一产出物。
范围
本文档仅描述项目级文档的管理规则，不包括公司级文档。
读者
所有软件工程人员应该阅读本文档，并遵从本文档的规则识别项目中产生的文档，并对其进行标识以及按照规范的格式撰写文档。
文档类别
类别
说明
代码
管理类
各种有关项目策划、度量、跟踪、调整的文档
MNG
需求类
各种与业务和需求相关的文档、模型
REQ
设计类
各种设计文档、模型等
DSN
实施类
与软件开发和集成相关的文档
IMP
测试类
测试相关文档、数据等
TST
发布类
发布声明以及各种用户文档
REL
参考资料类
各种参考资料
REF
文档清单
序号
文档中文名称
文档英文名称
文档代码
模板
评审级别
管理类（MNG）
1
立项申请
ProjectEstablishRequest
PER
/
组织级
2
项目任务书
StatementofWork
SOW
3
软件开发计划
SoftwareDevelopmentPlan
SDP
4
软件开发日程表
SoftwareDevelopmentSchedule
SDS
5
软件维护计划
SoftwareMaintainancePlan
SMP
6
任务单
TaskForm
TASK
7
项目跟踪报告
ProjectTrackingReport
PTR
8
项目总结报告
ProjectSummaryReport
PSR
需求类（REQ）
可行性分析报告
FeasibilityAnalysisReport
FAR
业务分析规格说明书
BusinessAnalysisSpecification
BAS
前景与范围
VisionandScope
VNS
软件需求规格说明书
SoftwareRequirmentSpecification
SRS
设计类（DSN）
总体设计说明书
GeneralDesignSpecification
GDS
项目级
数据库设计说明书
DatabaseDesignSpecification
DBDS
用户界面设计说明书
UserInterfaceDesignSpecification
UIDS
接口设计说明书
InterfaceDesignSpecification
IDS
详细设计说明书
DetailedDesignSpecification
DDS
实施类（IMP）
软件配置清单
SoftwareConfigurationList
SCL
软件开发文件
SoftwareDevelopmentFile
SDF
系统部署文档
SystemDeploymentDocument
SDD
测试类（TST）
单元测试用例
UnitTestCase
UTC
单元测试数据
UnitTestData
UTD
单元测试脚本
UnitTestScript
UTS
单元测试报告
UnitTestReport
UTR
集成测试用例
IntegrationTestCase
ITC
集成测试数据
IntegrationTestData
ITD
集成测试脚本
IntegrationTestScript
ITS
集成测试报告
IntegrationTestReport
ITR
9
系统测试用例
SystemTestCase
STC
10
系统测试数据
SystemTestData
STD
11
系统测试脚本
SystemTestScript
STS
12
系统测试报告
SystemTestReport
STR
发布类（REL）
产品技术白皮书
ProductTechnicalWhitepaper
PTW
系统安装手册
SystemInstallationManual
SIM
用户操作手册
UserOperationManual
UOM
产品维护手册
ProductMaintainanceManual
PMM
产品培训资料
ProductTrainingMaterials
PTM
产品发布声明
ProductReleaseNote
PRN
其它
评审报告
ReviewReport
RR
员工周报
WeeklyReport
WR
对于以上文档清单中未列出的文档，可参考以下编码规则以确定其代码：
参考编码规则
中文名称
英文名称
计划
Plan
PLN
样例
Sample
SMPL
模型
Model
MDL
文档
Document
DOC
数据
Data
DATA
工具
Tool
TOOL
脚本
Script
SCRP
报告
Report
RPT
问题
Issue
ISS
参考资料
Reference
文档标识
带版本文档
带版本文档指的是有版本修订、演进过程的文档，项目中绝大部分管理文档和技术文档（第三节的文档清单中以黑色字体标识）都是带版本的。
标识号（ID）
文档的标识号用于命名文档，同时写入文档的配置管理页与页眉中。
带版本文档的标识号形式为：
[项目/产品英文简称]-[系统/子系统/组件代码]-[文档类别]-[文档代码]
其中：
[项目/产品英文简称]：
项目/产品立项时确定的英文名称缩写，如OBS_1.0
[系统/子系统/组件代码]：
系统/子系统/组件代码用于标识文档的级别或其所属的子系统/组件。
对于系统级文档，该代码为SYS；
对于子系统/组件级文档，该代码为子系统/组件代码。
子系统/组件由项目经理在总体设计完成之前确定，并写入总体设计规格说明书
[文档类别]：
本文档第二节确定的文档类别
[文档代码]：
本文档第三节确定的文档代码，如果同类文档有多个，可以在本节加上两位数的编码。
样例：
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
为集成测试的第一组测试数据
版本号
版本号形式为x.y，其中y表示文档修订的次数，x表示文档发布的次数。
文档初始版本号为0.1，以后每产生一次修订，y+1
第一次发布的正式版版本号为1.0，以后每产生一次修订，y+1
重新评审和发布，x+1
无版本文档
无版本文档指的是由项目当前状态评估而产生的各种文档，如评审报告、SCM报告、SQA报告等各种报告以及任务单、变更请求表等表单。
在第三节的文档清单中以灰色字体标识。
项目文档
项目中无版本文档的标识号形式为：
[项目/产品英文简称]-[系统/子系统/组件代码]-[文档类别]-[文档代码]-[日期/编码]
本文档第三节确定的文档代码（若有本文档中未识别出来的文档，请及时通知您的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-SCM-CR-001
为项目的第一个变更请求
员工周报命名方式为：
WR-[NAME]（-[日期]）
[NAME]：
公司统一的Email帐号
[日期]：
项目规定的报告日期，形式为YYYYMMDD
WR-LIJUAN-20011121
文档格式
文档的格式包括：
文档封面
页眉和页脚
目录（正文10页以上的文档必须有目录）
标题与字体格式
配置管理页（所有带版本的文档必须有配置管理页）
评审记录（需要评审的文档应附评审及批准的记录）
无特殊情况文档均采用MicrosoftWord2007进行编辑。
文档修订
每次修订文档应填写配置管理页中的“修订历史”。
每次修订的内容应以蓝色字体标识。
评审记录
评审要求：
本文档需要组织级评审，参加评审的人包括SEPG以及主管技术的高级经理。
必须由SEPG组长、质量经理和高级经理共同签字批准才能生效。
批准人：
姓名
职务
签名
时间
升级会员 