软件开发流程管理规范

软件开发流程管理规范软件开发流程管理规范...................................................................................................................1一、概述...................................................................................................................................2二、流程...................................................................................................................................2三、附件...................................................................................................................................3附件一、编码规范...........................................................................................................31、命名空间.............................................................................................................32、命名规则.............................................................................................................32.1文件夹及相关文件命名规则.....................................................................32.2数据库表命名规则.....................................................................................43、代码规范.............................................................................................................43.1代码分层结构.............................................................................................43.2编码规范.....................................................................................................54、注释.....................................................................................................................64.1注释模板设置.............................................................................................64.2手工添加注释.............................................................................................74.3注释要求.....................................................................................................8附件二、软件需求申请表...............................................................................................9附件三、软件开发申请表.............................................................................................10附件四、项目组成成员表.............................................................................................11附件五、项目策划/任务书...........................................................................................12附件六、WBS表............................................................................................................13附件七、项目进度计划表.............................................................................................14附件八、项目风险管理表.............................................................................................15附件九、项目沟通计划表.............................................................................................16附件十、项目会议纪要.................................................................................................17附件十一、项目状态报告表.........................................................................................18附件十二、项目变更管理表.........................................................................................19附件十三、项目总结表.................................................................................................20一、概述随着公司规模的扩大、各部门对软件需求的激增、提高效率的工作要求，IT部门承接的软件开发项目越来越多，而与之相对应的就是软件开发流程不明确，软件项目的随意性较大、可追溯性较差、可统计性模糊、可预测性不足是摆在我们面前最直接的问题。为了适应公司的发展，IT部软件开发项目特制订本流程。二、流程由上图可以得出以下几个关键步骤：一、需求部门：I、需求部门首先需要填写《软件需求申请表》，说明需要开发的软件具体用途径、目前工作模式、工作不方便之处、基本功能等信息；II、待IT部门评审通过后，通知需求部门，填写《软件开发申请表》，具体列明需要实现的功能、目前工作流程、使用系统后需要达到的状态，可节省的人力、物力，调高的效率等信息；III、软件开发测试完成之后，接受IT部门的软件使用培训，并填写《参与培训确认单》；IV、软件试用结束后，填写《软件验收表》，完成软件项目的开发流程；V、在开发测试过程中，遇到开发风险增加、需求变更等，都需要配合IT软件开发人员填写相关的《项目风险管理表》和《项目变更管理表》。二、IT部门：I、积极对需求部门提出的《软件需求申请表》进行评审、审批，限3个工作日完成，及时反馈结果给需求部门；II、指导需求部门填写各类表格；III、积极评审需求部门填写的表格、积极沟通，有效获得相对准确的需求，并填写完善，让需求部门签字确认；IV、进入开发流程后，积极填写《项目成员组成表》、《项目策划任务书》、《WBS表》、《项目进度计划表》等（具体见附件）；V、积极开展人员培训和软件试用工作，编写完善的《XXX软件试用说明书》，并要求相关人员签字确认，并存档处理。三、附件附件一、编码规范1、命名空间1.公共类库（公司功能业务）：（1）全局公共类库：例：ECO.Common.DBhelper/Excel/email,生成dll文件，添加至最小应用库可全程序引用（2）局部公共类库（主要区分公司），命名方式为专有业务场景+专有业务名+具体类名：例：ECO.Gp（总部）/In（国内市场）/Rb（生产）注：（公共类库）信息登记、评审、信息共享，命名空间最多三层2.项目程序文件：项目文件名,以核心功能的英文名称为准,格式:ECO_英文名词首字母大写2、命名规则2.1文件夹及相关文件命名规则a)文件夹：功能文件夹，采用驼峰形式，首字母大写全称b)窗体文件：采用驼峰形式，首字母大写全称c)接口：I+采用驼峰形式，首字母大写全称d)方法名：采用驼峰形式，首字母大写全称e)窗体控件：同上f)局部变量：变量类型缩写（int，fl，str）+驼峰形式g)全局变量：不建议使用h)常量：全英文大写，不建议出现在页面i)数组：功能名称首字母小写+驼峰+Arrj)List集合：功能名称首字母小写+驼峰+Listk)字典：功能名称首字母小写+驼峰+Dicl)Dateset：功能名称首字母小写+驼峰+Dsm)DateTable：功能名称首字母小写+驼峰+Dt附表1：类型前缀（小写）+驼峰样式名词或名词短语对于基本类型变量，前缀如下表：类型前缀intintdoubledoufloatflstringstrboolbooldatetimedatbytebyt............对于对象类型变量，也可以采用类似基本类型方式，如StringBuilder类型，可使用sb作为前缀开头，后跟变量名驼峰样式。对于集合类型变量，如数组、List、Dictionary，可以在变量命名的基础上结尾加入集合类型简写。如，sqlList，dataDic等。2.2数据库表命名规则命名方法：项目大写首字母+_+功能（全英文大写）【多单词组成的，取单词首字母大写组合】表字段：类似变量命名索引:表名（或缩写）+_+列名+idx注：ID、创建人（creator）、创建时间（createTime）、状态（state）、创建人工号（createID）等字段为必须创建的字段;3、代码规范3.1代码分层结构建议每个模块中代码至少分三层结构,根据项目大小决定是否采用这种方式,可以先以一两个项目测试一下这种结构;表现层逻辑层数据层例如一个项目的一个模块，可以创建文件夹结构如下所示：表现层直接面向用户，逻辑层负责后端逻辑处理，数据层负责和底层数据库交互。表现层调用逻辑层代码，只有查询数据时，表现层可以直接调用数据层；逻辑层负责处理逻辑，为表现层提供调用接口，其数据操作需要调用数据层提供接口；数据层负责提供和处理数据，需要为逻辑层提供调用接口，所有与数据库的操作都只能