需求规格说明书.doc

文件编码文件密级最新发布日期当前版本XX软件股份有限公司公共代码及组件管理规范郑重声明：XX软件股份有限公司版权所有。本文档中任何部分未经XX软件股份有限公司书面授权不得将材料泄露给第三方不得以任何手段、任何形式进行复制与传播。变更履历版本日期变更理由/变更内容变更人备注1.0创建管理规范框架1.0根据研发中心公共代码管理规定对组件管理规范文档进行修改1.0增加了组件评审等流程以及对于跨部门代码复用目的的相关阐述1.0根据吴家仲等人的想法进行了修改1.0根据与sun的沟通结果进行了修改目录1总则31.1宗旨31.2原则31.3适用对象32术语定义43组件开发过程43.1通用组件开发43.2第三方组件采购54组件提交过程64.1组件提交流程64.2组件入库标准64.2.1组件库组件的纳入标准64.2.2评审通过的必要准备75组件维护升级过程75.1组件维护管理的几种情况75.1.1组件部维护的组件75.1.2其他部门维护的组件85.2组件升级86组件取用过程86.1组件的取用流程86.2组件取用情况统计规定97组件撤销过程9总则宗旨代码的复用水平是体现软件企业研发管理水平高低的重要标志。而组件的定义、管理则可以看作是代码复用的一个具体表现。随着公司组织结构的日益壮大研发部门的数量也日趋增多方向性（技术、业务）也趋向明朗化而或多或少的重复性开发也屡见不鲜此时跨部门代码复用的重要性和艰巨性也就日渐突显。为提高公司内部跨部门代码复用水平、促进各技术人员加强技术交流、分享开发经验特制定此组件管理规范。原则组件管理的原则（目的）是：提高公司内部跨部门代码复用水平、促进各技术人员加强技术交流、分享开发经验。按照组件在公司内可维护的能力将组件分成三类：通用型组件业务型组件第三方组件研究院组件部是组件库归口管理部门研究院组件部负责人是组件库主管人组件库主管人必须作好组件代码的登记、整理、统计和分发工作并定期将组件代码库的有关信息发布到公司内部的portal上供其他员工查询配置基线库是组件代码存放地配置管理员要定期作好组件代码库的备份工作组件代码的管理由以下几个过程来控制：组件开发过程组件提交过程组件维护升级过程组件取用过程组件撤销过程适用对象组件部成员、公司其他研发人员以及配置管理员等。术语定义No.术语定义1公共代码具有完整功能逻辑、能被应用于两个或两个以上的软件产品或项目的程序片段及其附属资料。公共代码可以是用某种程序开发语言书写的源代码及其的设计文档、使用说明资料也可以是以二进制形式存在的、能被复用的程序组件及相关的设计文档、使用说明资料、演示程序等。2组件为了解决功能或机制层面相较于类更大粒度复用的问题引入了组件的概念。简而言之我们可以把组件理解为对于一组具有某种或某些通性（如某种功能或某种机制等等）的公共代码的封装对外暴露一个或多个接口供外界调用。在本规定中组件包括三种类型：通用型组件和业务型组件以及第三方工具组件。3通用型组件与业务无关、能够被专人进行升级、维护的组件。通用型组件通常是支持一些公共控件、通用算法等。4业务型组件与业务有关、在某一业务领域或多个业务领域有普遍意义的组件。5第三方组件从第三方厂商购买或从网上的开放源码团队中获得的公共代码根据公司研发实际需要进行再次封装形成组件。这类组件通常核心部分在公司内不能维护升级只有再次封装部分可以进行维护升级。组件开发过程组件的功能开发过程应符合公司的软件开发规范具体这里就不进行描述了主要对通用组件开发申请及第三方组件采购的一些过程进行规定。通用组件开发提交申请讨论协商功能实现同意开发是否通用组件开发流程的说明如下：决定开发某个组件之前首先需要提交某组件的开发申请至组件部（申请方式可以为口头申请申请部门可以是组件部也可以是其他部门）收到申请后组件部组织讨论协商如果经讨论认为可以进行该组件开发原则上开发部门以组件部为主（如果组件部处于精力不足等状态可以组织协商来决定开发承担部门）组件开发申请通过后根据协商结果来组织相关人员进行功能实现第三方组件采购提交申请存在类似组件组件部核实评审组件取用否是评审通过组件部购买组件入库第三方组件购买流程说明如下：该流程主要针对其他部门发起的第三方组件购买申请组件部负责对申请的组件进行核实核实内容主要包括查找组件库中是否已经存在类似的组件如果发现有类似组件则走组件取用过程如果组件库中不存在类似组件则组织采购申请评审如果评审不通过则退出该流程如果评审通过组件部负责进行组件的采购相关事宜采购成功后组件部负责入库相关事宜参见组件提交过程新采购的组件提交入库之后组件部负责通知相关申请部门进行组件取用过程组件提交过程组件提交流程组件入库提交评审入库是否通过是否修改组件的提交过程说明如下：组件提交流程主要包括：提交、评审、入库提交过程主要包含两种方式：其他兄弟部