信息系统软件开发流程管理规范-初稿.doc

软件开发流程管理规范软件开发流程管理规范1一、概述2二、流程2三、附件3附件一、编码规范3、命名空间、命名规则32、 文件夹及相关文件命名规则2、数据库表命名规则3、代码规范43、1代码分层结构43、2 编码规范54、注释64、1注释模板设置4、2 手工添加注释7、3注释要求8附件二、软件需求申请表9附件三、软件开发申请表10附件四、项目组成成员表1附件五、项目策划任务书1附件六、WBS 表13附件七、项目进度计划表1附件八、项目风险管理表15附件九、项目沟通计划表1附件十、项目会议纪要7附件十一、项目状态报告表1附件十二、项目变更管理表1附件十三、项目总结表0一、概述随着公司规模得扩大、各部门对软件需求得激增、提高效率得工作要求,IT 部门承接得 软件开发项目越来越多,而与之相对应得就就是软件开发流程不明确，软件项目得随意性较大、 可追溯性较差、可统计性模糊、可预测性不足就是摆在我们面前最直接得问题。为了适应公司 得发展， 部软件开发项目特制订本流程。二、流程由上图可以得出以下几个关键步骤：一、需求部门:I、需求部门首先需要填写软件需求申请表,说明需要开发得软件具体用途径、目前 工作模式、工作不方便之处、基本功能等信息；II、待 T 部门评审通过后，通知需求部门,填写软件开发申请表,具体列明需要实 现得功能、目前工作流程、使用系统后需要达到得状态,可节省得人力、物力,调高得效率等信息;II、软件开发测试完成之后，接受 部门得软件使用培训,并填写参与培训确认单; IV、软件试用结束后,填写软件验收表,完成软件项目得开发流程； V、在开发测试过程中，遇到开发风险增加、需求变更等,都需要配合T 软件开发人员填写相关得项目风险管理表与项目变更管理表。 二、I 部门：、积极对需求部门提出得软件需求申请表进行评审、审批，限 个工作日完成,及时反馈结果给需求部门;I、指导需求部门填写各类表格; II、积极评审需求部门填写得表格、积极沟通，有效获得相对准确得需求，并填写完善,让需求部门签字确认;I、进入开发流程后，积极填写项目成员组成表、项目策划任务书、WBS 表、项目进度计划表等(具体见附件)；、积极开展人员培训与软件试用工作,编写完善得XXX 软件试用说明书,并要求相 关人员签字确认,并存档处理。三、附件 附件一、编码规范1、命名空间、公共类库(公司功能业务）：(1)全局公共类库：例：ECO、mon、DBhlerExcel/mil，生成 ll 文件,添加至最小应用库可全程序引用(2) 局部公共类库(主要区分公司）,命名方式为专有业务场景+专有业务名+具体类名:例：ECO、Gp(总部)I（国内市场)/Rb(生产）注:（公共类库)信息登记、评审、信息共享,命名空间最多三层、项目程序文件:项目文件名,以核心功能得英文名称为准，格式:E_英文名词首字母大写2、命名规则2、1文件夹及相关文件命名规则a) 文件夹:功能文件夹,采用驼峰形式,首字母大写全称) 窗体文件：采用驼峰形式,首字母大写全称c) 接口：I+采用驼峰形式,首字母大写全称 d) 方法名：采用驼峰形式,首字母大写全称 e) 窗体控件:同上f） 局部变量:变量类型缩写(it,fl,sr）+驼峰形式g) 全局变量：不建议使用h) 常量:全英文大写,不建议出现在页面i） 数组:功能名称首字母小写驼峰+Arrj）Ls集合:功能名称首字母小写驼峰+Listk)字典：功能名称首字母小写+驼峰+Dl)Datese:功能名称首字母小写+驼峰s m) Datebl：功能名称首字母小写+驼峰+Dt附表 1：类型前缀(小写)+驼峰样式名词或名词短语 对于基本类型变量,前缀如下表:类型前缀itintdoubledoflatflstringstrboolbooldatetiedatyeby、对于对象类型变量，也可以采用类似基本类型方式,如Sinuier 类型,可使用 sb 作为前缀开头,后跟变量名驼峰样式。 对于集合类型变量,如数组、Lit、Dictinar,可以在变量命名得基础上结尾加入集合类型 简写。如，q,atDi 等。2、数据库表命名规则命名方法：项目大写首字母+_功能（全英文大写)【多单词组成得,取单词首字母大写组合】 表字段：类似变量命名索引:表名（或缩写)+列名+dx 注：ID、创建人（retr)、创建时间(catTi)、状态(stae)、创建人工号(eateI) 等字段为必须创建得字段；3、代码规范、1 代码分层结构建议每个模块中代码至少分三层结构,根据项目大小决定就是否采用这种方式,可以先以一两个 项目测试一下这种结构;表现层数据层逻辑层例如一个项目得一个模块，可以创建文件夹结构如下所示:表现层页面 *、aspx 数据层 *、cs 逻辑层 *、cs表现层直接面向用户,逻辑层负责后端逻辑处理,数据层负责与底层数据库交互。表现层调用逻辑层代码,只有查询数据时,表现层可以直接调用数据层； 逻辑层负责处理逻辑，为表现层提供调用接口，其数据操作需要调用数据层提供接口； 数据层负责提供与处理数据,需要为逻辑层提供调用接口,所有与数据库得操作都只能在该 层实现。、2编码规范、2、1 通用a）类功能必须唯一：每个文件中只有一个类(不包括内部类)b)行宽限制在 80个字符内,必须按最低优先级换行）方法代码限制在200 行内d)类代码建议限制在5 行内e）方法参数过长，应分行显示,逗号至于末尾f)每行声明一个变量，且尽量赋初值,同类型必须连续写g）复合语句都需加大括号 ,不要写在一行,f、e 尽量配对出现，try、cac、iallyh)高扇入、合理扇出(尽量不超过三层)i）缩进不允许空行j)递归要慎用，goto 不允许使用k)方法内禁止更改传递过来得参数)实体类中变量应私有化,应包含每个变量得 et 及get 方法m） 避免三层以上嵌套循环n）代码应包含正确性与容错性处理(tr、atch、finally)o）编程时应考虑代码得效率(时间、空间),多循环内侧,变量声明放在循环外p)对象比较用对应方法不用“=”，例如：eqal,pr o q）计算尽量避免除法r)设计方法可重用性s） se、inl、cath、日志必须有出口 t） 堆常量统一定义，避免用常量字符串 u) 变量必须初始化3、2、2 表现层页面端1、JS 代码与CSS 代码统一放置在 html 得 head 子元素中；2、JS 代码需要有注释；3、页面控件有嵌套情况得，各级需要缩进，并且各级得头尾对齐；页面处理类1、页面加载时谨慎处理Sessio 置空；2、类中多处用到得变量建议创建成员变量,成员变量应私有化（prvte),位于类代码上方； 3、除用于 Ex、ne 前台调用得如 App、ect 方法需为 public 外,其她方法建议均为private; 、Pageoad 方法:建议将页面加载方法中内容加入if (！X、IsAjaxReust)代码块中,避免页面每次操作后都调用 Pag_Lad方法;5、获取页面得服务端控件得值前需对控件值得 null 与空进行判断，避免空指针异常;6、避免过多或复杂得逻辑处理代码,统一调用逻辑层代码,将展现与逻辑分离;7、对数据得增删改操作不要直接调用数据层，查询可直接调用数据层代码;、2、3 逻辑层、除对表现层提供得接口方法外,其她方法均保持私有 rive2、对数据库数据处理调用数据处理层代码3、对串行得数据处理时事务保证4、逻辑代码容错性保证、2、4 数据处理层、除对外提供得接口方法外,其她方法均保持私有prvate、对数据库得底层访问(获取数据库连接、执行 ql语句、数据库连接关闭)均调用数据 库操作帮助类、数据处理层类中只处理数据,避免业务逻辑代码4、sl 语句编写时避免使用“+5、数据库操作帮助类中数据库操作得容错性与事务处理（插入、更新、删除操作需要事务 保证)4、注释编写任何代码都需要有代码注释，并且代码修改后也要修改注释,保证代码注释同步。4、1 注释模板设置在 安装目录,以下目录中,找到cass、s 文件,修改保存后，重启 vs,之后创建新类时即会自动产生注释。D：ograFile(x6）MicrosoftsualStudio0、0mon7IEItemltsCachSharCod205Cl、z但就是修改后没有效果。、2手工添加注释创建新对象可以手工添加注释: 注释写法:块注释 注释包含在/*与/中,可以有多行。行注释以/开头,可以有多行,每行前面都以/开头.文件头注释/* =* Copyright 2013 ECOVACS Inc、 All rights reserved!* 科沃斯机器人科技(苏州)有限公司*=*/类文件注释/*DESC: 类功能描述* SINCE: 、net 版本* CREATOR: 创建人* DATE:创建日期*/方法注释/*DESC: 方法功能描述* PARAMS: 参数说明* RETURN: 返回值说明* CREATOR: 创建人* DATE:创建日期*/4、3 注释要求a)注释量:20%30,项目完成周期延长20% )注释地方:段前以及当行之后c)上线之前无需版本号,上线之后需版本号,上线前统一为、0d）注释与自身方法之间不为空,其她方法必须为空e)注释代码在上线后全删除,上线后不允许无效代码存在注：注释中得内容含创建人、创建时间、功能描述、参数说明、修改人、修改时间、修改描 述、返回值；上线后每个源码备份空间附件二、软件需求申请表需求部门:申请人：用途描述目前工作状态基本功能描述部门主管建议签字确认(时间)附件三、软件开发申请表需求部门：申请人：具体功能模块 说明目前工作流程项目完成所能 带来得预期效 益(可节省得 人力、物力等)部门主管建议签字确认(时间）附件四、项目组成成员表一、项目基本情况项目名称(Prjct Name）:项目编号(Proect d)：制作人(Peparedb):审核人(Rvied by)：项目经理(Prject ae):制作日期（Daa）:二、项目组成员成员姓名e项目角色Poject ole所在部门p Name职责Resoiilty项目起止日 期Data投入频度及 工作量 Time联系电话Tel o、主管经理Servisor签字 Sitre:日期Dae:项目赞助人 Sponsr项目经理 rjecManag项目角色包括项目赞助人(Sposor)、项目经理(Maagr）、项目核心成员（Core ta）与项目非核心成员(tedtem）附件五、项目策划/任务书一、项目基本情况项目名称（oject Nm）:项目编号(ProjecCoe):制作人（Peparb)：审核人（Revied y):项目经理(PrjecMnager)：制作日期(Data):二、项目描述1、项目背景与目得(所有得项目均起始于某个商业问题,该部分简要描述这些问题)、项目目标(包括质量目标，工期目标、费用目标与交付产品特征与特征得主要描述）、项目里程碑计划(包含里程碑得时间与成果)4、评价标准(说明项目成果在何种情况下将被接受)5、项目假定与约束条件(说明项目得主要假设条件与限制性条件)6、项目主要利益干系人(包括高管、客户、职能部门主管、供应商、项目赞助人、项目经理、项目组成成员等干系人）姓名类别部门职务附件六、B 表一、项目基本情况项目名称(rojec ame)：项目编号(Project Code)：制作人(Pardby)：审核人（Revedy)：项目经理(Proect nager）:制作日期(Data）:二、工作分解结构分解代码WBS oe任务名称a包含活动Activie Included工时估算Estiated Tme人力资源Estied R其她资源Emated Resources费用估计Etimate Cost工期Epected Days注：以上工期及费用估算均用最可能值附件七、项目进度计划表一、项目基本情况项目名称（Project ame）：项目编号（Pojec Co):制作人(Prepard by):审核人(Reewe by）：项 目 经 理( Prjct Manaer）：制作日期（Dta)：二、项目进度表周(Wk)012责任人Tem Member关键里程碑Mlestone开始tat2903112345678910112开工会 ickof meeting附件八、项目风险管理表一、项目基本情况项目名称(roect Nm):项目编号（roject Code）:制作人（Prepare y）：审核人（Reviewed ）：项目经理（Project Mnager)：制作日期（ata):二、项目风险管理风险发生概率得判断准则高风险:60%发生风险得可能性中风险：%发生风险得可能性低风险:30%发生风险得可能性序号Sequenc e NO、风险描述Risk Decription发生概率appenig Prbbili影响程度Influence gre风险等级Ris Level风险响应计划RiskRso Pla责任人Riskowner开放关闭OenCose d附件九、项目沟通计划表一、项目基本情况项目名称(oject e):项目编号（Pojec Cod)：制作人（Pepare y):审核人（Revieed y）:项目经理(PjectMnge):制作日期(aa)：二、项目沟通计划利益干系人Stakeholdrs所需信息In edd频率Frequcy方法Means责任人Rskowner附件十、项目会议纪要一、基本情况会议名称(Meeti ae):召集人（all y）:会议日期（Meting at）：开始时间(tr Time):会议地点（Meetng Plac）:持续时间（eetig Dton）:记录人(MitesBy）：审核人（RiwedB）：二、会议目标简要说明会议得目标,包括期望达到得结果三、参加人员(列出参加会议得人员，她在项目中得头衔或角色)四、发放材料（列出会议讨论得所有项目资料)五、发言记录(记录发言人得观点、意见与建议)六、会议决议(说明会议结论)七、会议纪要发放范围附件十一、项目状态报告表一、项目基本情况项目名称（Pject ame）:项目编号(PretCde):制作人(Prepared by):审核人（Reviewd y）:项目经理(Project Manger):制作日期(ata):当前项目状况按计划进行比计划提前落后计划汇报周期二、当前任务状态(简要描述任务进展情况）关键人物状态指示状态描述三、本周期内得主要活动(对本周期内得主要交付物进行总结）四、下一个汇报周期内得活动计划(描述活动需要与项目计划与 WBS相对应）五、财务状况六、上期遗留问题得处理(说明上一个汇报周期内问题得处理意见与处理结果）七、本期问题与求助附件十二、项目变更管理表一、项目基本情况项目名称（Prjec ame):项目编号(Prect Code):制作人（Peard by)：审核人(iewed y）:项目经理(rojct Manag):制作日期（Daa)：二、历史变更记录(按时间顺序记录项目以往得每一次变更情况）序号Seuence NO、变更时间Cang Dae涉及项目任务Ts ocernd变更要点Change 变更理由hy Rquet申请人Rueted By审批人AprvedBy三、请求变更信息（建议得变更描述以及参考资料）1、申请变更得内容、申请变更原因四、影响分析受影响得基准计划1、进度计划、费用计划3、资源计划就是否需要成本进度影响分析?就是否对成本得影响对进度得影响对资源得影响变更程度分类高 中低若不进行变更有何影响申请人签字申请日期五、审批结果审批意见审批人签字日期附件十三、项目总结表一、项目基本情况项目名称(ProjectNam):项目编号(Projt de):制作人（Prepaed b):审核人(vewed b）:项目经理(Proect Manager):制作日期（Data):二、项目完成情况总结1、时间总结开始时间：Start Dae计划完成时间Expected inishate实际完成日期ActualFins De时间（差异)分析2、成本总结计划费用实际费用成本（差异)分析3、交付结果总结计划交付结果实际交付结果未交付结果交付结果(差异）分析三、项目经验、教训总结签字 Stur日期te项目赞助人 Poect Snsor项目经理ProetManag