06需求定义01需求规格说明书.docx
- 文档编号:7835969
- 上传时间:2023-01-26
- 格式:DOCX
- 页数:8
- 大小:19.26KB
06需求定义01需求规格说明书.docx
《06需求定义01需求规格说明书.docx》由会员分享,可在线阅读,更多相关《06需求定义01需求规格说明书.docx(8页珍藏版)》请在冰豆网上搜索。
06需求定义01需求规格说明书
文件编码文件密级
最新发布日期当前版本
XX软件股份有限公司
公共代码及组件管理规范
郑重声明:
XX软件股份有限公司版权所有。
本文档中任何部分未经
书面授权,不得将材料泄露给第三方,不得以任何手段、任何形式进行复制与传播。
变更履历
版
本
日期变更理由/变更内容变更人备注
1.0
1.0
1.0
1.0
1.0
目录
1总则3
1.1宗旨................................3
1.2原则................................3
1.3适用对象................................
2术语定义................................3
3组件开发过程................................4
3.1通用组件开发................................4
3.2第三方组件采购................................5
4组件提交过程................................6
4.1组件提交流程................................6
4.2组件入库标准................................6
4.2.1组件库组件的纳入标准................................6
4.2.2评审通过的必要准备................................7
5组件维护升级过程................................8
5.1组件维护管理的几种情况................................8
5.1.1组件部维护的组件................................8
5.1.2其他部门维护的组件................................8
5.2组件升级................................9
6组件取用过程................................9
6.1组件的取用流程................................9
6.2组件取用情况统计规定................................10
7组件撤销过程................................10
总则
宗旨
1.代码的复用水平是体现软件企业研发管理水平高低的重要标志。
而组件的定
义、管理则可以看作是代码复用的一个具体表现。
2.随着公司组织结构的日益壮大,研发部门的数量也日趋增多,方向性(技术、
业务)也趋向明朗化,而或多或少的重复性开发也屡见不鲜,此时,跨部门代码复用
的重要性和艰巨性也就日渐突显。
3.为提高公司内部跨部门代码复用水平、促进各技术人员加强技术交流、分享
开发经验,特制定此组件管理规范。
原则
1.组件管理的原则(目的)是:
提高公司内部跨部门代码复用水平、促进各技
术人员加强技术交流、分享开发经验。
2.按照组件在公司内可维护的能力,将组件分成三类:
1)通用型组件
2)业务型组件
3)第三方组件
3.研究院组件部是组件库归口管理部门,研究院组件部负责人是组件库主管人,
组件库主管人必须作好组件代码的登记、整理、统计和分发工作,并定期将组件代码
库的有关信息发布到公司内部的portal上供其他员工查询
4.配置基线库是组件代码存放地,配置管理员要定期作好组件代码库的备份工
作
5.组件代码的管理由以下几个过程来控制:
1)组件开发过程
2)组件提交过程
3)组件维护升级过程
4)组件取用过程
5)组件撤销过程
适用对象
组件部成员、公司其他研发人员以及配置管理员等。
术语定义
No.术语定义
No.术语定义
1公共代码公共代码可以是用某种程序开发语言书写的源代码及其的设计文
档、使用说明资料,也可以是以二进制形式存在的、能被复用的程
序组件及相关的设计文档、使用说明资料、演示程序等。
2组件(如某种功能或某种机制等等)的公共代码的封装,对外暴露一个
或多个接口,供外界调用。
在本规定中,组件包括三种类型:
通用型组件和业务型组件以及第
三方工具组件。
3
通用型组与业务无关、能够被专人进行升级、维护的组件。
通用型组件通常
是支持一些公共控件、通用算法等。
4与业务有关、在某一业务领域或多个业务领域有普遍意义的组件。
5
第三方组据公司研发实际需要进行再次封装,形成组件。
这类组件通常核心
部分在公司内不能维护升级,只有再次封装部分可以进行维护升
级。
组件开发过程
组件的功能开发过程应符合公司的软件开发规范,具体这里就不进行描述了,主
要对通用组件开发申请及第三方组件采购的一些过程进行规定。
通用组件开发
通用组件开发流程的说明如下:
提交申请讨论协商功能实现
同意开发
是
否
1.决定开发某个组件之前首先需要提交某组件的开发申请至组件部(申请方式
可以为口头申请,申请部门可以是组件部也可以是其他部门)
2.收到申请后组件部组织讨论协商,如果经讨论认为可以进行该组件开发,原
则上开发部门以组件部为主(如果组件部处于精力不足等状态可以组织协商来决定开
发承担部门)
3.组件开发申请通过后,根据协商结果来组织相关人员进行功能实现
第三方组件采购
第三方组件购买流程说明如下:
1.该流程主要针对其他部门发起的第三方组件购买申请
2.组件部负责对申请的组件进行核实,核实内容主要包括查找组件库中是否已
经存在类似的组件,如果发现有类似组件则走组件取用过程
3.如果组件库中不存在类似组件,则组织采购申请评审,如果评审不通过则退
出该流程
4.如果评审通过,组件部负责进行组件的采购相关事宜
5.采购成功后,组件部负责入库相关事宜,参见组件提交过程
6.新采购的组件提交入库之后,组件部负责通知相关申请部门进行组件取用过
程
提交申请组件部核实
评审
组件取用
否
是
评审通过
组件部购买
组件入库
组件提交过程
组件提交流程
组件的提交过程说明如下:
1.组件提交流程主要包括:
提交、评审、入库
2.提交过程主要包含两种方式:
1)其他兄弟部门同事推荐
2)组件部主动收集(代码及需求)
3.提交评审由组件部来进行组织,评审遵循的组件入库标准请参见2.1
库标准。
4.评审人员包括:
组件部相关人员、项目组相关人员(组件由其他项目组提交)、
相关领导。
5.组件基本信息文档在评审通过之后由组件部整理,并最终交由提交人签字确
认(如果评审未通过则需要相关提交人员根据评审结果来查漏补缺,如完善代码注释、
补充必要的资料文档等等,修订后重新提交组件部,由组件部再次组织评审)
6.组件部会同配置管理员利用配置管理工具在配置基线库中预留目录,并将组
件必要的源码、资料等一并入库。
7.组件入库之后组件部需要进行验证和完善的过程
8.组件部需定期整理“公司组件信息表”并发布到公司内部的portal供员工备
查,组件部可以根据实际需要将组件库的相关资料也一起发布到公司内部的portal
网上备查
9.配置管理员需定期对公共代码库备份
组件入库标准
组件入库标准旨在规范允许纳入组件库的组件的鉴定标准及通过评审的必要准
备。
组件库组件的纳入标准
鉴定一个组件是否属于可以纳入组件库主要遵循如下原则:
1.属于通用型组件类型的组件可以纳入组件库进行管理,具体请参见“1.2.3
提交评审入库
是否通过
是
否
修改
通用型组件”,如不包含业务含义的打印组件等。
2.属于第三方组件类型的组件可以纳入组件库进行管理,具体请参见“1.2.5
第三方组件”,如公司购入的图表组件等。
3.业务型组件类型的组件,除了根据“1.2.4业务型组件”鉴定其业务普遍性
之外,还需要对于业务普遍性的跨部门复用进行界定,即如果某个业务组件的业务普
遍性仅仅是体现在某个部门内部,则不允许纳入组件库进行管理,纳入组件库的业务
组件前提是至少“已经”被两个或多个部门在相关项目的业务功能上被复用。
如
ezreport报表组件等。
评审通过的必要准备
为了更好的通过组件的入库评审,组件提交者(可能是组件部成员,也可能是其
他研发部门成员)需要完成如下准备:
序号考核条目通过标准是否必须备注
1代码注释完成率为100%,其它代码注释完成率是
2编码规范组件代码编写符合公司制定的编码规范是
3单元测试单元测试覆盖代码率达到40%以上是
4功能测试提供功能测试用例,覆盖需求率为100%否
业务组件
必须提供
5API文档是
6使用手册是
7demo程序否
视具体情
况定
注:
以上考核条目可以视具体情况通过提交部门与组件部进行协商来决定具体有
谁提供,如提交部门精力不允许的情况下可以协商组件部进行demo程序的开发等等
组件维护升级过程
这里的组件主要指纳入公司组件库的组件,其维护管理主要分为如下几种情况:
组件维护管理的几种情况
组件部维护的组件
1.组件的维护管理原则上以组件部为主
2.通用型组件维护的负责部门是组件部。
组件部须指派专人对通用型组件整合、
维护和升级,并完成有关的说明文档、使用手册和演示程序的编写。
3.第三方组件维护的负责部门也是组件部。
具体情况与通用型组件类似。
其他部门维护的组件
1.在需求非常紧急而组件部又精力不够的情况下,组件部可以授权给其他部门
对相关组件的部分进行修改,修改人员对修改或更新部分需要提供给组件部必要的更
新说明,并对修改部分重新入库,组件部需要定期进行检查、核对。
2.业务型组件由于业务领域的特殊性(也有可能因为组件部精力不够等情况),
某些业务型组件入库后经评审决定维护人员允许指定为其他研发部门成员。
当第三方
部门需要取用该组件时,可以提交申请给组件部,组件部从中进行组件发布、维护的
相关协调工作
3.第三方部门也可以直接提交申请给维护人员,并进行相关的协调工作,但需
同时通知组件部,组件部负责对相关情况进行确认,核实后计入组件取用统计范畴,
否则不计入组件取用统计范畴(参见组件的取用过程)。
组件升级
4.组件每发布一个新版本(如果是其他部门维护的组件,发布新版本时需要通
知组件部,并提供必要的发版说明和版本共享路径),组件部需在“公司组件信息表”
中增加一个条目及相应的组件编号、维护人等内容,原有版本仍然保留,组件新版本
的发布仍然遵循组件提交过程中的规定。
5.对于新版本的发布,组件部需要在portal上进行消息发布,必要情况下需要
给指定人群进行邮件通知,附带发版说明。
6.对组件维护升级,尽量不修改组件中原有方法,如果进行了修改,必须根据
组件的取用情况对所有取用项目组进行邮件通知,并及时对API文档等进行更新。
7.项目组在使用组件的过程中,如果发现错误,错误发现人在缺陷管理系统中
向组件部报告错误,描述错误的触发条件和错误情形,组件部对发现的错误进行纠正
或者协调维护组件的其他部门对错误进行纠正。
8.组件更新有两种触发方式:
1)组件部定期跟踪
2)提交人主动提出更新
9.在组件维护的过程中组件部需要进行验证和完善的过程(文档检查、测试等
等)
组件取用过程
组件的取用流程
1.组件取用过程是控制组件被其他项目组或研发人员使用的过程。
组件取用过
程相对简单,主要流程如下:
2.组件的取用过程说明如下:
1)需要组件的相关人员跟组件部提出口头申请
2)组件部进行相关的支持,这里一方面是指提供必要的技术支持,另一方面如
果该组件是由其他部门成员进行维护,组件部需要从中进行取用的相关协调工作。
口头申请
组件部进行相关支持
3)组件部需要对组件的取用情况(如组件版本、取用项目,取用申请人等)进
行必要的记录,定期出具组件取用统计数据。
组件取用情况统计规定
组件取用情况统计主要遵循如下规则:
1.对于每次组件取用,组件部需要记录组件取用次数、对应的项目组等信息(参
见“组件取用记录情况表”)。
2.年终由组件部出具组件整体的取用情况统计数据
组件撤销过程
组件的撤销主要是指对组件库中的记录的组件信息定期进行检查,经评审认为该
组件已经不适合继续在组件库中保留,此时可以对该组件进行撤销处理。
组件撤销的相关说明如下:
1.组件部负责定期对组件库中的组件进行普查,普查的频率为一个季度进行一
次
2.判断某组件需要撤销遵循如下几个标准(需同时满足一下标准):
1)该组件在公司当前所有产品中未被使用
2)该组件目前无维护开发计划
3)该组件超过一年未被取用
是否需要撤销定期检查评审
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 06 需求 定义 01 规格 说明书