南京见贤软件配置管理规范V1.0

文件编号：ST-GF-01-002-2017文件级别：二级版本号：V1.0南京见贤信息科技有限公司体系文件软件配置管理规范拟制：____________校对：____________审核：____________会签：________________________________________________核准：____________批准：____________2016-12发布2017-1实施南京见贤信息科技有限公司审批标识号确认人日期目的为确保产品在软件生命周期中的完整性和可追溯性，配置管理活动被用来设计标识配置项、建立基线、控制版本和变更、保证变更被适当地实施，使开发人员、测试人员、项目管理人员、质量保证人员等能方便地通过软件配置管理获得有用的信息，特制定本规范。范围本规范适用于公司项目技术文档、管理文档、源代码等配置管理。术语和省略语软件配置管理：软件配置管理的目的是建立和维护在项目的整个软件生命周期中软件项目产品的完整性。软件配置管理活动是有计划的；所选定的软件工作产品是已标识的、受控的和适用的；对已标识的软件工作产品的更改是受控的；受影响的组和个人得到软件基线的状态和内容的通知。软件配置项：软件配置项（SCI）是指工程过程所生产或使用的任何元素，或者是纳入软件产品的元素。可能是说明书、计算机程序、数据结构或开发软件产品使用的工具。所有定义产品的元素的全体称为软件配置。软件工作产品：由定义、维护和使用一个软件过程所产生的任何人工制品，包括过程描述、计划、规程、计算机程序和相关文档，无论是否打算将它们交给客户或最终用户。软件产品：可交付给客户或最终用户的软件工作产品的子集称作软件产品。基线：基线是经过评审和批准的配置项的集合，其作用是明确划分项目各阶段，确定各阶段的结束点。配置状态报告：是配置管理过程中，配置人员应对所有提交的产品进行管理控制，并记录配置项和它的状态，进行的配置状态的说明和报告。变更控制：配置管理的一部分，包括在配置标识正式建立之后，对配置项的更改进行评价、协调、认可或不认可以及执行更改的过程。产品构造：将软件的代码文件构造为一个软件系统的过程。配置审计：考查软件基线库的结构、内容和设施，以验证基线和描述它的文档的一致性。配置库：为项目建立或可以利用的一个仓库，用于存储软件配置项和相关联的配置管理信息。职责本制度的责任部门是软件研发部，负责对本规范的意见收集、改进更新和解释工作。管理规定配置管理总则软件资产集中统一管理一般情况下，公司所有研发组使用公司要求的配置管理工具进行软件配置管理。特殊情况下，如果项目组无法在公司的配置管理系统中统一管理，应采取适当措施保证定期与公司服务器同步，研发结束时，将项目所有软件工作产品归档到公司配置服务器。实施合理的权限管理在公司级、部门级和项目组级实现项目/目录/文件级的权限管理，对不同部门、不同产品组、不同项目组的人员根据需要赋予不同的权限，能够有效的实现公司级的知识共享并保证每个组和个人开发工作的独立和完整。及时做好备份管理公司配置管理员要进行公司级的定期备份，服务器出现问题后能够尽最大可能进行恢复。特殊情况下，未纳入公司配置管理系统管理的项目组要保证做好及时备份。设立配置管理组织设立公司、部门及项目组三级配置管理员为配置管理活动提供组织保证。建立配置审计机制为保证公司配置库的完整性、相关活动的规范性和工作产品的正确性，执行配置审计。配置管理组织结构公司软件配置管理采用三级管理模式，即公司级、部门级和项目级配置管理。公司级配置管理5.2.1.1公司配置管理主管工作职责：全面负责公司配置管理工作。公司配置库结构规划设计及配置管理规范建设。配置管理组织建设。推进技术部门产品及项目配置库在公司受控。5.2.1.2公司配置管理员工作职责：公司配置管理系统的维护、配置库维护、备份。使用配置工具技术支持，配置管理工具使用的优化、改进。产品发布配置审计、产品入库、产品发布。配置管理审查。协助配置管理主管推行制定的规范、制度。部门级配置管理每部门设一名部门配置主管（由部门经理或副经理兼任）和一名兼职部门配置管理员。5.2.2.1部门配置主管工作职责：配合公司推进部门配置管理工作，协调相关配置管理活动。拥有本部门产品、项目分支（目录）管理员权限，负责确定、设置、调整部门产品组和项目组人员及权限。配合公司确定本部门产品配置策略、产品配置结构、协调推动执行。5.2.2.2部门配置管理员工作职责：培训指导部门开发人员使用配置管理工具。协助解决本部门开发人员使用配置管理工具中遇到的问题。负责保证本部门的所有项目数据的完整性，将外地项目组提供的需要与公司服务器同步的数据同步到公司服务器中，要求至少两周同步一次。负责提出部门人员在配置管理系统中的帐号添加、删除，在公司配置库创建产品和项目等相关活动的申请与执行。监督推进本部门项目配置管理员的工作。监督和宣贯公司配置管理规范在部门的执行。项目级配置管理对于每个立项、登记的研发项目设立一名专兼职项目配置管理员。可由部门配置管理员兼任，对于规模比较大（例如项目组开发人员超过10人）的项目可考虑设立专职项目配置管理员。在项目经理的协助和授权下根据项目计划制定项目的配置管理计划。项目配置管理计划需经相关人员评审并由公司配置管理主管审核。项目配置管理员根据项目配置管理计划执行项目配置管理活动。当项目组使用独立的配置管理系统时，负责项目组存储库的备份，备份要求每周全备份，每天增量备份；在项目经理的授权下，在配置管理系统中实施公司确定的配置管理策略，包括：创建标记：只有项目配置管理员完全控制项目所有的标记，其它人员只能使用经过授权的标记；只有项目配置管理员完全控制公司规定的目录结构，其它人员不允许创建新的目录；已确定为基线的标记，不允许删除；负责控制项目变更的执行。项目组用户管理，项目配置管理员向公司配置管理员申请实施项目组成员的访问权限控制。软件存储库设计基于公司现状，在公司配置服务器建立统一存储库，规划如下表：存储库配置服务器配置管理平台存储库安装路径存储库备份路径备注Svn192.168.1.10Svn存储系统独立备份服务器管理文档及开发产品、项目源码软件配置库设计软件配置管理的对象是软件工作产品，因此如何将软件工作产品按照有序的目录结构进行合理地组织与存放是非常重要的。其中，项目管理分支存放除技术文档之外的所有其他项目文档，包括项目计划、项目跟踪、测试、总结、配置管理、质量保证等。对公司所有产品及项目对应的配置库结构列表如下：一级二级三级四级备注部门一01项目配置库SourceBranchesTagsTrunkBB、CW、WL等模块技术文档项目管理文档02项目配置库参照01项目配置库03项目配置库参照01项目配置库……配置项命名规范配置标识命名规范，就是指配置项标识命名约定。制定适当的命名规则是配置标识的重要工作，命名不能任意或随机地进行，命名要求具有唯一性、规范性，目的在于避免出现重名、造成混乱并能快速识别。配置项可以分为文档类和源程序类。文档类一般将一个文件作为一个配置项管理；源程序类可以根据使用的开发工具决定以一个模块所有源代码文件作为一个配置项，还是以一个源代码文件作为一个配置项。文档类配置项命名5.5.1.1标准文档的命名要求：文件名是唯一的、不重复的；文件名应该能够明确表达该文档的内容和版本即可。5.5.1.2文档命名规则可以定为：产品名（项目名）+文档名<_模块>+版本。比如：物流管理系统需求规格说明书v2.1。源程序类配置项命名5.5.2.1对于源代码程序一般配置项管理到模块，当然管理到源代码文件也可以。下面分别给出模块和源代码文件作为配置项的命名：5.5.2.2模块作为配置项的标识命名规则：子系统名+模块名。子系统名+模块名建议使用拼音简写。5.5.2.3源代码文件作为配置项的标识命名规则：模块名+表意字串+扩展名。其中，表意字串部分一般是指该子系统+模块下的一个功能描述。功能描述应做到简单明了，推荐采用拼音简写命名方法进行描述。在模块名和表意字串之间以下划线连接或直接连接。举例说明：子系统+模块，如GS物流子系统一个模块drp_arap可命名为gswl_DRP_ARAP；源代码文件，如：SD模块下销售发票管理源文件可命名为SD_SalesInvoiceMgr.cs。标记命名5.5.3.1在项目开发过程中，规范的标记名称能够帮助判断产品的内部基线版本和发布版本。5.5.3.2标记名称可由拼音字母、数字和下划线组成，通过“REL”和“BL”来区分发布版本和基线版本。5.5.3.3发布版本标记的命名格式为“REL_产品名_版本号”；所有的标记名称中的英文字母均为大写。例如：REL_生产_V3.0：生产产品发布版本3.0。5.5.3.4开发过程中建立产品和项目基线标记命名格式为“BL_产品名（项目名）_版本号_BUILD号”；所有的标记名称中的英文字母均为大写。BL_WL_2.0_BUILD007：物流产品基线2.0build007。5.5.3.4适当时间建立的标记格式为“BL_产品名_年月日”例如：BL_WL_20060515：物流产品源码20060515。分支（目录）命名分支名称可由英文字母和下划线组成，格式为“产品名（项目名）_分支分类”，其中分支分类包括源码、文档，可以是中文。所有的分支名称中的英文首字母均为大写。工作程序工作流程5.6.1.1工作程序：项目经理接受部门经理任务，开始组建项目组。项目经理提交项目启动报告后，项目管理部给项目组指定配置管理员。项目编号规则：采用公司立项项目编号.项目经理与配置管理员共同制定配置管理计划。公司配置管理员和项目配置管理员根据配置管理计划创建配置库，在异地开发项目在项目开发现场安装配置管理工具进行配置管理，在公司开发项目使用公司现有配置库进行配置管理工作。5.6.1.2输入：项目配置管理申请表5.6.1.3输出：配置管理计划配置管理项目创建5.6.2.1工作程序：分为异地开发，和在公司现场开发两种情况；在异地开发项目由项目配置管理员定期备份到公司配置库。配置管理员收到通过审批《项目配置管理申请表》后，根据《项目配置管理申请表》在公司配置管理库创建项目。在配置管理库中添加用户，分配相应的权限，分配项目配置管理员。5.6.2.2输入：《项目配置管理申请表》5.6.2.3输出：项目配置管理计划入配置管理库目管理部负责归档的文件，由配置管理员负责检入配置管理库项目的对应分支下受控；项目其他文档、源代码由项目经理、开发人员负责检入配置管理库项目的对应分支下受控。配置管理库审计项目管理部配置管理员负责配置管理库项目审计，并出具相应的报告。日常工作要求5.7.1研发工程师每天上班后在开发环境中，要先做一次与“与资源库同步”将服务器与本地文件进行对比，然后手工解决版本冲突，或是直接更新，将服务器上的文件变更覆盖本地的文件。5.7.2修改本地工作区文件之前必须先执行“与资源库同步”或是“更新”操作，以保证本地文件是最新版本。对于公共文件的修改，要先告诉公共文件负责人，自己需要修改哪个文件，由负责人记录后，才可以对该文件进行修改，修改完毕后再及时通知公共文件负责人，以免出现不必要的冲突问题。5.7.3研发工程师每天至少一次将最新的源程序检入到配置管理服务器。5.7.4由规定当前工作区文件修改后应立即进行本地化保存,以免丢失文件。5.7.5配置管理员在进行工具版本升级时,必须先在测试环境下升级成功后，并出具报告经项目经理同意后，才能在生产环境下升级.否则由此引起的后果由配置管理员承担。5.7.6当检入工作产品到服务器一定要加上注释说明。注释要求说明上传的内容和修改的原因等。5.7.7其他使用配置工具管理文档的人员，参照上述要求执行。存储库备份管理存储库管理中一项重要的工作是数据库的备份。为了保证项目信息的安全、完整性，公司采取存储库统一备份的策略；在异地进行开发，不能使用公司统一配置库的项目，项目组需参考公司的备份策略自行备份。备份分类按照备份规模可分为：公司级和项目级（异地项目，无法使用公司统配置库的备份）。备份策略5.8.2.1SVN配置系统，对存储库在每月某做进行全备份，保留最近时间的4次备份。5.8.2.2在异地进行开发，不能使用公司统一配置库的项目，项目组需参考公司的备份策略自行备份。项目组需要定期（公司要求至少每二周同步一次，由对应项目软件经理负责）将相应数据同步到公司存储库，实现公司级的配置库统一管理。附件《项目配置管理申请表》《配置管理计划》《项目配置管理审核及报告》《配置管理报告》

附件1配置管理立项申请表编号：项目名称：项目编号申请人：申请日期：工具类型□需求管理□版本管理□变更管理项目组成员需求管理项目权限人员项目需求经理项目需求分析员变更管理项目权限人员任务管理流程需求变更流程缺陷跟踪流程版本管理目录分支权限人员Bringover权限Putback权限创建本地工作区的权限创建标记的权限列表权限审核意见：项目经理签字:日期:部门经理签字:日期:分管经理签字:日期:使用说明:在填写申请内容时应尽可能详细和全面。附件21.人员及职责提示：（1）根据《项目计划》中的角色分配，确定配置管理员，CCB（配置控制委员会）成员。（2）CCB的人数根据项目规模而定。一般地，项目经理是CCB的负责人。角色人员职责、工作范围2.用于配置管理的软硬件资源配置管理员CCB配置管理计算机配置管理软件CVS安装目录配置库名称配置库目录机器IP系统管理员3.配置管理工作计划时间工作内容工作产品责任人备注4.配置库目录结构说明在配置管理库创建项目时按照下面的分类创建目录结构二级目录以下目录结构根据项目的情况定制。5.用户设置及权限项目配置管理员根据项目需要建立目录，使用配置管理工具CVS对项目配置库按照不同目录设置对应不同用户设置读写增加删除的权限。用户由配置管理员在操作系统中统一建立用户名和口令。所有使用CVS的用户必须在CVS系统里有自己的用户名。该用户名使用姓名拼音格式建立，初始密码同用户名。用户名为：姓名为三个字，姓全拼＋名的声母，例如：张建利（zhanjl）。姓名为两个字，姓名的全拼，例如晏杰（yanjie）.配置库创建用户列表如下：项目用户列表序号组类型姓名用户名说明6.配置项计划提示：配置管理员标识配置项，估计每个配置项的正式发布时间。标识符的参考格式为Project-Type…Type-Number。例如：类型主要配置项标识符责任人预计正式发布时间7.基线审核计划基线名称计划建立时间基线审核时间责任人8.配置库备份还原计划提示：配置管理员制定配置库备份计划，指明“何人”在“何时”（频度）将配置库备份到“何处”。1、备份手工备份：每周将整个目录压缩备份到见贤公司配置管理服务器。自动备份：使用系统备份工具定制计划任务每天备份文件到目录。2、还原 使用系统备份工具还原。选中最新备份文件目录，在系统空间足够的硬盘创建一还原目录，在“将文件还原到(R):”选框中选择“替换位置”，在“备用位置”中浏览选择之前创建的还原目录进行还原。备份频度、时间责任人备份内容、目的地、方式等附件3项目配置管理审核表项目名称:审核次数：第次时间：地点：项目经理：审核人员：内容符合部分符合不符合不适用备注项目配置管理初始化是否有文档化的经批准的项目开发管理计划√项目计划是否明确规定程序清单和配置项产生的时间√没有规定程序清单项目配置管理目录是否按照公司规定目录结构设置√项目是否按照规定提交项目配置管理申请单√未提交待补项目是否已经使用配置管理工具进行版本控制√项目配置管理项目组是否严格按照规定步骤进行日常操作√项目组是否将最新build上传到server按照计划未启动测试组是否在server下载最新build进行测试按照计划未启动测试组是否将报告上传到server指定目录√发布工程师是否看到最后通过的测试报告后发布项目产品√按照计划未启动如果基线有变化,是否按照规范进行评审后进行变更.√没有规范的评审过程