配置开发库文档的命名表

做为项目组的人员比较关心一下几个问题:

  1. 按照CMMI3的标准,项目组要提交到SVN的文件清单(识别配置项)。
  2. 每个文件的命名规范,比如:封面和修改记录中的版本命名规则。在SVN库中应该如何使用?
  1. 到底是《XXXX项目用户需求说明书v0.2》还是《XXXX项目_用户需求说明书V0.2》?
  2. 文档传到SVN库中,到底是《XXXX项目用户需求说明书V0.1》还是《XXXX项目用户需求说明书》?
  3. 一个500页的《概要设计说明书》,能不能拆成若干模块进行撰写?如果可以拆成不同模块撰写,那么如何命名?比如《概要设计说明书_模块1》;如果拆分成了不同的模块撰写,设计基线应该包括哪些内容?
  1. 项目配置库的命名要求是什么?中文命名、英文首字母缩写、拼音首字母缩写?如果第三方自己管理配置库,而且使用了旧的配置库,那么应该如何管理?是否要建立单独的统一配置库?
  2. 有哪些基线?基线是如何命名的?不同的产品有不同的基线,如何保持各个产品集成时,版本能够保持一致?
  3. 配置库的地址是什么?配置库的目录结构和人员权限是怎么样的?
  4. 项目有哪些基线?每个基线命名规则是什么?什么时候应该打基线?打完基线怎么通知项目组?
  5. 配置审计什么时候做?多久做一次比较合适?发现的问题应该怎么处理?
  6. 需求变更,如果引起了项目进度、成本变更应该如何处理项目计划?
  7. 测试阶段需求变更,如果引起了需求规格说明书的变更、设计说明书的变更、代码变更,应该如何处理?
  8. 版本发布应该如何操作?比如:多久发布一次?项目组发布程序,应该有哪些配套的文档做运维?版本的命名规则和方法是什么样子的?发布以后应该通知谁?
  9. 体系文件因为不停的修订,如何保证每个EPG成员及时修改了自己的版本?如何保证各个参与体系建设的人员都知道体系文件的版本发生了修订和变更?如何发布基线版本?
  10. 不同的项目组先后拿到的是体系文件不同的基线版本,应该如何保持体系文件的版本不混乱?最新版可用,还是使用最稳定的版本?如何保证QA检查时,项目组使用的不同版本的模板都可以通过检查?

 

 

适用前提文档类型命名方式适用文档示例说明
1.产品在研发过程中有分多个版本迭代开发,并且产品命名有唯一的标识。
2.软件产品不是系列产品中的一员,有能够区别于系列产品的唯一英文缩写或简称。
3.产品有多版本的情况但是建立了文档版本与产品版本映射的追踪矩阵进行配置管理。
版本变化型文档提交SVN时记录版本信息
项目名称或编号
+文档功能名称+V1.0
(主版本+里程碑版本)
项目总体计划XXX_项目总体计划V1.0.doc1.文档入SVN配置库时,使用提交的备注功能标注版本号。
2.对于电子文档,还要在文档的修订记录中体现。
3.两个版本号应该一致。
4.要想查找某个版本的文档了,只要通过SVN中的备注信息就可以方便定位。
5.不提倡在文档名中体现版本号,如:需求报告1.1、需求报告1.2等。否则SVN中将保存多个类似的文档,不便于文档的查找和使用,也会占用大量的资源
配置管理计划 
质量保证计划 
项目进度计划 
用户需求规格说明书XXX_用户需求规格说明书V1.0.doc
产品需求规格说明书 
概要设计说明书 
数据库设计说明书 
详细设计说明书 
用户操作、维护手册 
测试用例 
时间区别型文档文档名称有明确的含义,需要用时间标识的日常性文档。
项目名称或编号+文档名称+撰写时间
周例会会议纪要XXX_周例会会议纪要20130901.doc 
评审报告109日召开的项目总体方案评审
命名为:
XXX_总体方案评审报告20130910.doc
 
项目月计划  
项目月总结  
阶段性计划  
更变申请表  
时间序号型文档多人同时提交同一份文件时,可以在标识的后面加入人名拼音缩写来区别。
项目名称或编号
+文档名称 +撰写时间+人名拼音缩写
系统测试报告XXX_系统测试报告_ 20140812_huxian.doc
XXX_系统测试报告_ 20140812_wangling.doc
 
项目周报XXX_项目周报_ 20140812_huxian.doc
XXX_项目周报_ 20140812_wangling.doc
 
多人一天多次提交同一性质的文件(文件的内容不同),可以在标识上同时加入序列号和人名拼音缩写来区别。
项目名称或编号+文档名称 +撰写时间+序列号+人名拼音缩写
单元测试报告XXX_单元测试报告_20140812_01_wangling.doc
XXX_单元测试报告_20140812_02_wangling.doc
XXXX_系统测试报告_20140812_01_xiaolei.doc
XXX_系统测试报告_20140812_02_leixiao.doc
 

 

 中文名英文名缩写
项目管理文档项目立项申请Project Start ApplicationPSA
可行性研究报告Feasibility Analyze ReportFAR
可行性研究评审报告Feasibility Analyze Report ReviewFARR
项目任务书Project Task DocumentPTD
软件质量保证计划Software Quality Assurance PlanSQAP
软件配置管理计划Software Configuration Management PlanSCMP
软件项目整体计划Software Project PlanSPP
软件开发计划Software Development PlanSDP
开发风格Development StyleDS
   
    
项目技术文档项目工作陈述State  of WorkSOW
功能列表Feature ListFL
用户需求User’s RequirementsUR
功能需求Functional RequirementsFR
软件需求规格说明Software Requirements SpecificationSRS
接口协议Interface Protocol DocumentIPD
数据库设计说明书DataBase Design DocumentDBDD
详细设计说明书Design Document DD
数据字典Data DictionaryDD
E-R模型E-R ModelERM
数据流图Data Flow DiagramDFD
概要设计说明书Preliminary Design DocumentPDD
    
基线及其评审需求基线Requirement BaselineRB
需求基线评审报告Requirement Baseline ReviewRBR
概要设计基线Preliminary Design BaselinePDB
概要设计基线评审报告Preliminary Design Baseline ReviewPDBR
产品基线Product BaselinePB
产品基线评审报告Product Baseline ReviewPBR

 

产品文档基线清单
分类文档名称命名规则适用范围撰写人员
工程类需求说明书XXXlabel_需求说明书V1.0内部使用市场,研发,测试
概要设计说明书XXXlabel_概要设计说明书V1.0内部使用研发
详细设计说明书  XXXlabel_详细设计说明书V1.0内部使用研发
数据库设计说明书XXXlabel_数据库设计说明书V1.0内部使用研发
测试用例 XXXlabel_测试用例V1.0内部使用测试
测试报告 XXXlabel_测试报告V1.0内部使用测试
维护类基线功能表XXXlabel_基线功能表V1.0内部使用研发,测试
产品更新表XXXlabel_产品更新表V1.0内部使用研发,测试
产品遗留bug清单XXXlabel_产品遗留bug清单V1.0内部使用测试
安装部署手册(研发)XXXlabel_安装部署手册V1.0内部使用测试
用户手册(用户部署安装使用)XXXlabel_用户手册V1.0外部使用测试
操作手册XXXlabel_操作手册V1.0内部使用,外部使用测试
维护计划XXXlabel_维护计划V1.0内部使用,裁剪内容外部使用 
配置管理类版本配置清单XXXlabel_版本配置清单内部使用测试

 

产品库目录结构
SVN库名一级目录二级目录存放工作产品示例
项目字母简称xxx产品产品文档基线1.0  XXXlabel_需求说明书V1.0
XXXlabel_概要设计说明书V1.0
XXXlabel_详细设计说明书V1.0
XXXlabel_数据库设计说明书V1.0
XXXlabel_测试用例V1.0
XXXlabel_测试报告V1.0
XXXlabel_基线功能表V1.0
XXXlabel_产品更新表V1.0
XXXlabel_产品遗留bug清单V1.0
XXXlabel_安装部署手册V1.0
XXXlabel_用户手册V1.0
XXXlabel_操作手册V1.0
XXXlabel_维护计划V1.0
产品文档基线1.1  XXXlabel_需求说明书V1.0
XXXlabel_概要设计说明书V1.1
XXXlabel_详细设计说明书V1.1
XXXlabel_数据库设计说明书V1.1
XXXlabel_测试用例V1.1
XXXlabel_测试报告V1.1
XXXlabel_基线功能表V1.1
XXXlabel_产品更新表V1.1
XXXlabel_产品遗留bug清单V1.1
XXXlabel_安装部署手册V1.0
XXXlabel_用户手册V1.0
XXXlabel_操作手册V1.0
XXXlabel_维护计划V1.0
版本配置清单 

 

  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

黄鹤的故乡

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值