软件研发配置管理规范.doc

tellhow软件研发配置管理规范一、目的与意义为了保证研发中心研发项目文件的安全性、机密性；保证软件产品的完整性、有效性及可追溯性，特制订本规范。二、适用对象本办法适用于软件产业本部下属相关软件经营单位或部门三、术语术语描述软件配置管理是在项目开发中，标识、控制和管理软件变更的一种管理。基线是项目开发库中每个工件版本在特定时期的一个“快照”。它提供一个正式标准，随后的工作基于此标准，并且只有经过授权后才能变更这个标准。建立一个初始基线后，以后每次对其进行的变更都将记录为一个差值，直到建成下一个基线。开发库（devlib）存放开发过程中需要保留的各种信息，供开发人员个人专用。开发人员对其具有编辑、修改、删除等操作权限基线库（baselib）开发库中产品经过测试小组测试后，行成一个稳定的版本，由配置管理员从开发库中将该版本提取出来，行成一个新的版本。以后的版本更新将在此基础上进行更新。所有人员对基线库的最大权限只能为只读权限。四、角色与职责角色职责项目经理确定配置项、确定配置库目录权限；审查配置库变更；项目开发过程中，监督配置库使用情况；员工离职时，配置库归档完整性审核。开发小组根据配置管理制度规范，进行配置库的日常使用测试小组从开发库中取出版本进行整合测试；负责验证代码变更及修改是否正确执行。测试小组测试通过的版本方可放入基线库。研发中心对项目中的变更进行管理、监控；协调开发小组、测试小组、配置管理员进行配置库的优化和管理。配置管理员负责配置库的建立、权限设置、负责培训开发人员使用配置管理工具、对配置库使用情况进行管理和监督、建立配置库基线；定期备份配置库；建立和完善配置管理制度。五、配置管理范围1) 配置管理包括：所有研发项目文档、源代码、可执行程序，特殊工具及相关资料等。2) 项目文档：立项建议书、项目计划、需求分析报告、概要/详细设计说明书、数据库表结构、测试文档以及项目过程中管理类文档。3) 特殊工具及其相关资料指开发或测试过程中比较特殊的工具，以及其使用文档等，如觉得有必要也纳入配置库的管理。六、配置库建立流程图如下：1) 项目立项时，由项目经理申请建立项目配置库，配置管理员与项目经理确定配置项，并参考附录二：配置库目录结构，建立配置库以及配置库目录结构；项目经理提供配置库权限清单（内容应包括员工姓名、项目名称、目录权限等），由配置管理员为相关人员的设置配置权限。2) 配置库权限设置完成之后，由配置管理员将配置库名称、访问路径、访问权限等信息以邮件方式通知各相关人员；配置库使用人员以各自的用户名和密码进行访问配置库。3) 配置库密码只能在服务器上设置，如配置库使用人员密码遗忘，可以与配置管理员取得联系，进行修改密码。七、配置库权限变更管理1) 若在使用配置库的过程中需要变更配置库管理权限，可以由项目配置管理员或项目经理以邮件或口头方式通知配置管理员，配置管理员变更之后，将变更结果以电子邮件方式通知受影响的人员、项目经理、项目配置管理员及其相关人员。2) 配置管理员根据配置库权限变更频率，决定每隔一段时间将配置库权限清单与各项目经理进行审核确认，各项目经理审核后，若有权限需要进行变更，应及时通知配置管理员。八、测试阶段配置库使用流程流程图如下：1) 配置库基本结构如“附录二”所示，通常以项目名称作为一级目录，二级目录包括：trunk、manager、test、tag： 其中“trunk”目录通常为项目组开发人员具有读写权限，其他人根据需求进行相应权限设置。该目录包含doc（文档）、src（代码）目录；src下包括四个目录：demo、源代码、发布包、数据库，其中“发布包”内容为空； “manager”目录通常为研发中心和项目相关人员共同使用； “test”目录为测试人员使用；由于开发人员需要将发布包放置在该目录下，所以开发人员对该目录也具有读写权限，但其不允许修改除“测试版本”目录外的其它目录的内容。 “tag”目录放置发布版本，只有项目组开发人员对其具有读写权限；开发人员在该目录下不允许对源代码等文件进行修改，但需将代码编译后放置在“发布包”目录下，同时将版本说明等测试人员需要的项目文档放在该目录下。注：配置库权限根据实际情况可以进行调整。2) 以pm_v1.0项目为例说明测试时配置库使用流程：当项目经理确定项目需要提交测试时,由项目开发人员通过branch/tag的方式将“src”在tag目录下建立版本分支,例如图中的pm_v1.0b1001,其下内容包括trunk/src下所有内容,开发人员在pm_v1.0b1001下编译后,将编译后的文件放在“tag/pm_v1.0b1001/发布包”目录下,同时需将版本说明文档等相关文档放在该目录下。3) “发布包”中的内容完善之后，项目开发人员将“tag/pm_v1.0b1001/发布包”在“test/测试版本”目录下建立tag，tag名称为“pm_v1.0b1001”（即对应发布版本名称），其下内容为发布包中的内容。图一4) 测试人员针对“test/测试版本/pm_v1.0b1001”下的发布包进行测试。5) 若需发布新的版本,请重复24步骤。九、基线库建立流程图如下：1) 开发库经测试小组整合测试完成后，配置库达到一个阶段的稳定版本，由项目经理向研发中心和配置管理员提出申请，建立基线库。 2) 由项目经理、测试小组负责人确定开发库中通过测试的对应版本号，并填写研发中心基线库建立申请表。项目经理、测试人员必须保证准备进入基线库中的所有文档、代码、可执行程序等相互对应，保证准备入库资料的完整性和一致性。3) 项目经理将研发中心基线库建立申请表提交给配置管理员。4) 配置管理员根据研发中心基线库建立申请表中相应内容建立基线库，将正确的版本对应的所有资料纳入基线库管理。5) 基线库使用者的权限只能为只读权限。使用者向项目经理或部门经理提出权限需求，在领导同意之后，配置管理员设置相应权限，并通知相应人员。十、配置库备份1) 配置管理员应定期做好配置库的备份，以防意外引起的服务器上资料的丢失，避免给公司带来严重的损失。2) 配置管理员每周进行硬盘备份一次，每两个月进行光盘备份一次,备份后的光盘标记上备份日期并附上内容清单，移交公司保管。十一、配置库使用1) 所有立项的项目，都必须申请建立配置库。开发过程中所有文档和代码必须纳入配置库管理，若因未纳入配置库管理造成的资料丢失或版本差异，其责任皆由开发人员及项目经理承担。2) 配置库服务器密码只有配置管理员和研发中心掌握，其他人如因特殊原因需要该密码，必须经过研发中心批准后方能获取；并在使用完密码之后，通知研发中心和配置管理员，配置管理员及时设置新的密码，以保证服务器资料的安全性和机密性。3) 各配置库的使用人员必须使用各自的用户名和密码进入配置库，访问各自的配置库。各使用人员不得将自己的用户名和密码泄漏给其他人员，若因泄露密码而引起的后果将由泄漏密码者本人承担。4) 项目组成员未经项目经理同意不得更改他人的文档和代码。各项目的配置库用于项目组正式开发使用，项目组成员不得恶意对其进行修改、删除、增加等操作；若因对svn工具不熟悉，需要学习，可以向配置管理员提出需求，由配置管理员为其提供可以练习的配置库。5) 各项目经理负责定期检查配置库的使用情况，查看是否有员工进行无故删除或恶意修改文件的行为;并对开发人员提交的文档和代码的及时性、准确性和完整性进行检查。6) 在研发人员离职时，由其项目经理负责检查配置库，检查该人员提交的代码或文档是否完全放入配置库管理，确认版本和相应文件完整无误后，项目经理在“员工离职申请单”中签字，该员工方可离职。同时项目经理应及时通知配置管理员，取消该人员的所有权限。若因项目经理审核不细致造成的代码或文档移交不完整，或项目经理未及时通知配置管理员取消权限，而造成的损失，该责任完全由项目经理承担。7) 在配置库使用时，为了避免配置库update或commit时引起冲突，需注意： 项目经理在划分模块时注意每个人的模块之间不要重叠。 开发人员在修改文件之前，养成事先update的习惯。 开发人员注意commit的频率，尽量及时commit，规定每天提交一次。附录一：配置项命名规则配置项目命名基本要求：唯一性；可追溯性。1项目名称命名规范：要求项目名称不能太长，且必须要求使用该项目的英文缩写命名。项目名称中最好不出现空格，若有空格，在建立配置库时，配置库名中将以“_”来代替空格。2配置库命名配置库分为开发库和基线库。 一个项目的开发库命名为：项目名称缩写_dev 一个项目总基线库的命名为：项目名称缩写_bas 若一个项目的基线库有多个,可以在其下建立各版本的基线库,子基线库命名规则为:项目名称缩写+版本号_bas 若一个项目的开发库有多个,可以在其下建立各版本的开发库,子开发库的命名规则为:项目名称缩写+版本号_dev3项目各文件夹命名：每个项目在配置库中可以再分为两个库，开发库（devlib）和基线库（baselib）在这两个库的下面，又可分为如下文件夹：docs、src、test、manager 文件夹名字中不允许出现空格。4技术文档命名：技术文档的标识体现在相应文件的封面上，规范如下：一级项目名称+二级项目名称三级项目名称文档名称版本, 由开发人员参照相应文档模板的格式要求，对技术文档进行标识。5项目版本编写规则：参见软件版本管理办法相关规定。附录二：配置库目录结构每一个项目的配置库可分为devlib（开发库）和baselib（基线库），如下为开发库的建库样例，基线库与开发库结构相同，但基线库和开发库各自独立，分开管理。每个项目的都可以分为如下，并可以根据实际情况增减：一级目录二级目录三级目录四级目录项目名称_版本号trunkdocs立项预研项目计划需求分析概要设计详细设计验收产品资料结项src源代码demo数据库发布包test单元测试集成测试系统测试测试版本项目名称_版本号_修订版本号工具压力测试manager规范组织制度周例会月度会议技术讨论其它tag项目名称_版本号_修订版本号(其下为trunk/src目录下所有内容)附录三：基线库建立申请表研发中心基线库建立申请表项目名称项目经