1软件配置管理规定模板.docx
《1软件配置管理规定模板.docx》由会员分享,可在线阅读,更多相关《1软件配置管理规定模板.docx(14页珍藏版)》请在冰点文库上搜索。
1软件配置管理规定模板
软件配置管理规定
文档信息:
软件配置管理规定
文档名称:
软件配置管理规定
文档类别:
管理过程文件
密级:
机密
版本信息:
建立日期:
创建人:
审核者:
批准人:
批准日期:
保管人:
编辑软件:
MicrosoftOffice2010中文版
文档修订记录
版本编号或者更改记录编号
*变化
状态
简要说明(变更内容和变更范围)
日期
变更人
批准日期
批准人
V1.0
A
*变化状态:
A——增加,M——修改,D——删除
主要内容
1
简介
1.1目的
为了指导项目经理及相关人员建立并使用配置库,保证项目文件的安全性、机密性;保证软件产品的完整性、有效性及可追溯性,以及加强研发及项目协同能力,特制定本制度。
1.2适用范围
本文档的适用范围为部门所有研发及市场项目。
部门采用VisualSourceSafe2005(简称VSS)作为配置管理工具,有关软件安装及使用请见《配置库用户使用操作手册》。
1.3角色及职责
角色
职责
项目经理
1、确定配置库目录及权限;
2、在项目开发过程中,监督配置库的使用情况;
3、员工离开项目时,配置库归档完整性审核;
4、按《项目质量及里程碑计划》及时输出相关管理文档
项目组员
1、在项目开展的过程中严格遵守配置库操作规范;
2、按《项目质量及里程碑计划》及时输出相关技术文档及代码文档。
配置管理员
1、负责配置库的建立及管理、权限设置、变更管理;
2、负责培训开发人员使用配置管理工具;
3、对配置库的使用情况进行管理和监督,定期进行检查审计;
4、定期备份配置库;
5、建立和完善配置管理制度。
2配置管理范围
项目开发过程中产生的所有文档,包括:
项目管理文档、技术文档、源代码、可执行程序,工具及相关资料等。
主要管理文档:
项目计划、会议记录及项目过程中管理类文档等。
主要技术文档:
需求、概要设计说明书、详细设计说明书、数据库表结构、测试文档、使用说明书、技术说明书等。
工具及相关资料:
开发或测试过程中的工具,以及其使用文档等,如有必要也纳入配置库的管理。
3项目配置库建立与使用
3.1项目配置库建立
项目立项时,由项目经理与配置管理员根据《配置库基本结构》(附件3),共同确定项目配置库目录结构及人员权限并记录在《配置库权限清单》(附件1)中。
在开发管理的过程中,根据实际需要,项目经理可提交《配置库权限变更单》(附件2),酌情修订配置库目录及权限。
权限分配:
配置管理员为相关人员分配配置库权限完成后,将配置库的名称、访问路径、访问权限等信息以邮件方式通知各相关人员;配置库使用人员以各自的用户名和密码访问配置库。
如配置库使用人员密码遗忘,可以与配置管理员取得联系进行修改密码。
3.2项目配置库使用
配置库基本结构如“附件3”所示,一级目录包括:
管理域、工程域、测试域、发布域共4个区域。
每个项目都按照配置库基本结构规划,4大区域目录为必选项,其它目录可以根据实际情况增减。
管理域:
存放项目管理文档,为项目经理使用;
工程域:
项目组日常开发活动区,该目录包括技术文档和代码文档;
测试域:
项目组在此目录下记录项目测试中的文档,如内部测试、集成测试及测试报告;
发布域:
存放最终发布给客户的程序及文档。
4配置库安全
配置库服务器系统安全:
配置管理员进行服务器的日常管理与维护,做好防入侵、防病毒工作。
配置库备份:
配置管理员根据配置库变更频率定期做好配置库的备份,以防意外,避免给公司带来严重的损失。
备份采取两种方式:
1)根据配置库变更的频率进行异地备份,放到备份服务器上。
售后项目每变更一次备份一次,正开发实施项目每周备份一次。
2)进行异地备份的同时进行移动硬盘备份,进行妥善保管。
5配置库使用规范
5.1基本原则
各项目必须建立配置库且使用部门提供的配置管理环境建立;项目的配置库管理工作由项目经理负责。
各配置库的使用人员必须使用各自的用户名和密码进入配置库,访问各自的配置库。
若因泄露自己的用户名和密码引起的后果将由泄露密码者本人承担。
开发、实施过程中项目组成员编写的与本项目有关的文档和程序代码必须提交配置库;未提交配置库造成的资料丢失或版本差异,其责任由项目组成员及项目经理承担。
项目组成员未经项目经理同意不得更改他人的文档和代码。
若对配置工具不熟悉,可以向配置管理员提出需求,由配置管理员为其提供可以练习的配置库。
各项目经理负责定期检查配置的使用情况,并对开发、实施人员提交的文档和代码的及时性、准确性和完整性进行检查。
在开发、实施人员离开项目时,由其项目经理负责检查配置库,检查该人员提交的代码或文档是否完全放入配置库管理,确认版本和相应文件完整无误。
若人员离职项目经理在“员工离职申请单”中签字,该员工方可离职。
同时,项目经理应及时通知配置管理员,取消该人员的所有权限。
若因项目经理审核不细造成的代码或文档移交不完整,或项目经理未及时通知配置管理员取消权限而造成的损失,该责任完全由项目经理承担。
5.2代码提交原则
每次提交代码前,先进行更新,以避免提交冲突;
任何文档、代码,不能以压缩文件的方式放入配置库中;
原则上,应该在完成某个功能或函数的开发或修改之后,再提交代码,避免提交功能不完整的代码。
提交到配置库中的代码必须能正确编译。
常见的问题是创建了新文件,但没有加到配置库中,导致其他人更新代码后编译不通过。
原则上,每天工作开始时项目组成员从配置库中签出要编写、修改的文档或代码到桌面,进行编写、修改工作;每天下班前,项目组成员必须将签出的文档签入库中,适当的在comment中简单记录修改说明,如:
问题分析、修改内容等关键信息。
项目验收后及售后的每次修改必须将所有文件及代码进行lable标记,并填写《版本更新说明》(附件4),在lable内说明本次更新内容对应的《版本更新说明》文件。
开发人员能链接虚拟平台配置库服务器,必须将代码更新到该服务器项目配置库上,不能连接该服务器的将项目配置库带到工作现场,每月至少提交1次最新配置库备份。
5.3代码提交规范
为了能实现项目代码的自动编译,代码提交必须遵守以下规范,否则将导致代码不能自动编译和发布,由此造成的损失由该系统负责人员承担。
.Net项目
1)要使用VisualStudio自身配置管理功能进行源码提交;
2)源码提交的同时将所有引用dll包含到项目的提交文件中;
3)对于解决方案内的项目间引用不要包含在项目中。
4)项目配置库目录需要包含两个文件夹目录“项目源码”、“发布文档”
项目源码:
项目源码应放在“系统实现\网络系统”文件夹目录下,文件夹目录名称和结构自定。
解决方案中使用的所有资源(引用的外部类库、资源文件等)以及编译后生成的相关文件均必须包含在同一目录下,解决方案中生成的文件路径不允许使用绝对目录。
编译生成的目录中包含所有必须的文件以及最新的编译生成文件,可以直接进行项目发布。
发布文档:
发布文档应放在“系统发布”文件夹目录下,文件夹目录名称和结构自定。
包含发布需要的相关文件,如:
发布程序、上线功能清单、数据库更改清单、数据库更改文件、版本更新说明等。
Delphi项目
1)对于只能使用VSS直接进行提交的源码,原则上要求不能包含编译生成的文件;
2)不允许随意使用规定范围外的其他控件;
3)对于修改的源码或控件源码,请在项目内包含涉及的pas单元文件。
4)每个系统配置库目录结构包含3个文件夹目录,分别为bin、help、source目录。
bin目录存放可执行程序及程序运行所包含的所有相关DLL、配置文件、本地数据库文件。
help目录存放程序运行所需参数及安装说明,按照说明文件能够正确的实施系统,同时程序每次功能升级及代码修改后,在《版本更新说明》(附件4)中注明本版本和上次版本之间的功能差异及更新说明。
source目录下直接存放源代码,不允许再设子目录。
6配置管理考核
为能将配置管理贯彻执行,配置管理员要不定期对各项目配置库的使用情况进行监督,每季度进行全面检查,对检查过程中发现的问题根据严重程度给予通报、经济处罚或辞退处分。
对于未使用项目配置库的项目,考核项目经理1000元;现场配置库归档不及时考核项目经理200元。
泄露自身密码引起严重后果的,将由泄露密码者本人承担,根据严重程度考核200至5000元;
项目组成员恶意对配置库及内容进行修改、删除、增加等操作,处以1000元以上罚款,情节严重者予以辞退;
文档未提交配置库造成资料丢失或版本差异,考核开发人员500元,项目经理负管理责任,考核项目经理500元;
开发、实施人员提交的文档和代码不及时、不准确或不完整,一经发现,考核开发、实施人员200元,项目经理负管理责任,考核项目经理200元;
开发、实施人员工作交接,若因项目经理审核不细造成的代码或文档移交不完整,项目经理未及时通知配置管理员取消权限而造成的损失,处以项目经理1000元以上罚款。
未按照配置库管理规定,正确的存放代码结构,造成管理流程(如:
自动编译发布流程)无法执行者,视系统规模及影响程度处罚50-500元罚款。
项目进入售后阶段,项目组成员修改程序代码后要在一周内将源代码上传至配置库,超过一周未上传配置库者,一经发现,考核责任人300元。
7附录
附件1:
《配置库权限清单》
附件2:
《配置库权限变更单》
附件3:
《配置库基本结构》
附件4:
《版本更新说明》
附件1:
配置库权限清单
配置库权限清单
项目名称
项目经理
配置库名称
开通日期
权限列表
#
一级目录
二级目录
三级目录
姓名1
姓名2
姓名3
1
管理域
项目计划
R
C
A
项目报告
项目评审
问题管理
项目变更
项目会议
风险管理
实施管理
2
工程域
方案合同
系统需求
系统设计
……
……
……
3
……
……
……
备注:
配置库的权限共分4级:
R、C、A、D。
R:
Read,只读
C:
CheckOut/CheckIn,修改文件
A:
Add/Rename,Delete增删文件
D:
管理员权限
附件2:
《配置库权限变更单》
配置库权限变更单
项目名称
申请人
申请日期
申请期限
申请原因
开通权限
详细说明
项目负责人
意见
签字:
日期:
附件3:
《配置库基本结构》
配置库基本结构
#
一级目录
二级目录
三级目录
1
管理域
项目计划
项目报告
项目评审
问题管理
项目变更
项目会议
风险管理
实施管理
交流备忘录
培训记录表
用户使用评价表
2
工程域
方案合同
系统需求
需求调研
需求分析
系统设计
框架设计
概要设计
详细设计
数据库设计
系统实现
第三方控件
网络系统
上位机系统
下位机系统
终端系统
系统发布
用户手册
安装程序
3
测试域
单元及集成测试
系统测试
测试报告
4
发布域
安装程序
用户手册
附件4:
《版本更新说明》
版本更新说明
系统名称
版本号
变更人
变更时间
版本变更说明
序号
模块
描述
1
2
3
版本升级说明
步序
描述
1
2
3
4
5