软件开发流程管理规范汇总.docx
《软件开发流程管理规范汇总.docx》由会员分享，可在线阅读，更多相关《软件开发流程管理规范汇总.docx（18页珍藏版）》请在冰豆网上搜索。
软件开发流程管理规范汇总
软件开发流程管理规范
软件开发流程管理规范...................................................................................................................1
一、概述...................................................................................................................................2
二、流程...................................................................................................................................2
三、附件...................................................................................................................................3
附件一、编码规范...........................................................................................................3
1、命名空间.............................................................................................................3
2、命名规则.............................................................................................................3
2.1文件夹及相关文件命名规则.....................................................................3
2.2数据库表命名规则.....................................................................................4
3、代码规范.............................................................................................................4
3.1代码分层结构.............................................................................................4
3.2编码规范.....................................................................................................5
4、注释.....................................................................................................................6
4.1注释模板设置.............................................................................................6
4.2手工添加注释.............................................................................................7
4.3注释要求.....................................................................................................8
附件二、软件需求申请表...............................................................................................9
附件三、软件开发申请表.............................................................................................10
附件四、项目组成成员表.............................................................................................11
附件五、项目策划/任务书...........................................................................................12
附件六、WBS表............................................................................................................13
附件七、项目进度计划表.............................................................................................14
附件八、项目风险管理表.............................................................................................15
附件九、项目沟通计划表.............................................................................................16
附件十、项目会议纪要.................................................................................................17
附件十一、项目状态报告表.........................................................................................18
附件十二、项目变更管理表.........................................................................................19
附件十三、项目总结表.................................................................................................20
2007
一、概述
随着公司规模的扩大、各部门对软件需求的激增、提高效率的工作要求，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数组：
功能名称首字母小写+驼峰+Arr
jList集合：
功能名称首字母小写+驼峰+List
k字典：
功能名称首字母小写+驼峰+Dic
lDateset：
功能名称首字母小写+驼峰+Ds
mDateTable：
功能名称首字母小写+驼峰+Dt
类型前缀（小写）+驼峰样式名词或名词短语
对于对象类型变量，也可以采用类似基本类型方式，如StringBuilder类型，可使用sb作为前缀开头，后跟变量名驼峰样式。
对于集合类型变量，如数组、List、Dictionary，可以在变量命名的基础上结尾加入集合类型简写。
如，sqlList，dataDic等。
2.2数据库表命名规则
命名方法：
项目大写首字母+_+功能（全英文大写）【多单词组成的，取单词首字母大写组合】表字段：
类似变量命名
索引:
表名（或缩写）+_+列名+idx
注：
ID、创建人（creator）、创建时间（createTime）、状态（state）、创建人工号（createID）等字段为必须创建的字段;
3、代码规范
3.1代码分层结构
建议每个模块中代码至少分三层结构,根据项目大小决定是否采用这种方式,可以先以一两个项目测试一下这种结构;
例如一个项目的一个模块，可以创建文件夹结构如下所示：
表现层直接面向用户，逻辑层负责后端逻辑处理，数据层负责和底层数据库交互。
表现层调用逻辑层代码，只有查询数据时，表现层可以直接调用数据层；
逻辑层负责处理逻辑，为表现层提供调用接口，其数据操作需要调用数据层提供接口；数据层负责提供和处理数据，需要为逻辑层提供调用接口，所有与数据库的操作都只能在该层实现。
3.2编码规范
3.2.1通用
a
b
c
d
e
f
g
h
i
j
k
报考
r
s
t
u类功能必须唯一：
每个文件中只有一个类（不包括内部类）行宽限制在80个字符内，必须按最低优先级换行方法代码限制在200行内类代码建议限制在1500行内方法参数过长，应分行显示，逗号至于末尾每行声明一个变量，且尽量赋初值，同类型必须连续写复合语句都需加大括号{}，不要写在一行，if、else尽量配对出现，try、catch、finally高扇入、合理扇出（尽量不超过三层）缩进不允许空行递归要慎用，goto不允许使用方法内禁止更改传递过来的参数实体类中变量应私有化，应包含每个变量的set及get方法避免三层以上嵌套循环代码应包含正确性和容错性处理（try、catch、finally）编程时应考虑代码的效率（时间、空间），多循环内侧，变量声明放在循环外对象比较用对应方法不用“==”，例如：
equals，compareto计算尽量避免除法设计方法可重用性else、finally、catch、日志必须有出口堆常量统一定义，避免用常量字符串变量必须初始化
3.2.2表现层
页面端
1、JS代码和CSS代码统一放置在html的head子元素中；
2、JS代码需要有注释；
3、页面控件有嵌套情况的，各级需要缩进，并且各级的头尾对齐；
页面处理类
1、页面加载时谨慎处理Session置空；
2、类中多处用到的变量建议创建成员变量，成员变量应私有化（private），位于类代码上方；
3、除用于E前台调用的如App.direct方法需为public外，其他方法建议均为private；
4、Page_Load方法：
建议将页面加载方法中内容加入
if（!
X.IsAjaxRequest
{
}
代码块中，避免页面每次操作后都调用Page_Load方法；
5、获取页面的服务端控件的值前需对控件值的null和空进行判断，避免空指针异常；
6、避免过多或复杂的逻辑处理代码，统一调用逻辑层代码，将展现和逻辑分离；
7、对数据的增删改操作不要直接调用数据层，查询可直接调用数据层代码；
3.2.3逻辑层
1、除对表现层提供的接口方法外，其他方法均保持私有private
2、对数据库数据处理调用数据处理层代码
3、对串行的数据处理时事务保证
4、逻辑代码容错性保证
3.2.4数据处理层
1、除对外提供的接口方法外，其他方法均保持私有private
2、对数据库的底层访问（获取数据库连接、执行sql语句、数据库连接关闭）均调用数据库操作帮助类
3、数据处理层类中只处理数据，避免业务逻辑代码
4、sql语句编写时避免使用“+”
5、数据库操作帮助类中数据库操作的容错性和事务处理（插入、更新、删除操作需要事务保证）
4、注释
编写任何代码都需要有代码注释，并且代码修改后也要修改注释，保证代码注释同步。
4.1注释模板设置
在vs安装目录，以下目录中，找到class.cs文件，修改保存后，重启vs，之后创建新类时即会自动产生注释。
D:
\ProgramFiles（x86\MicrosoftVisualStudio
10.0\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052\Class.zip
但是修改后没有效果。
4.2
手工添加注释
创建新对象可以手工添加注释：
注释写法：
块注释
注释包含在/*和*/中，可以有多行。
行注释
以//开头，可以有多行，每行前面都以//开头。
文件头注释
类文件注释
方法注释
4.3注释要求
a注释量：
20%~30%，项目完成周期延长20%
b注释地方：
段前以及当行之后
c上线之前无需版本号，上线之后需版本号，上线前统一为1.0
d注释与自身方法之间不为空，其他方法必须为空
e注释代码在上线后全删除，上线后不允许无效代码存在
注：
注释中的内容含创建人、创建时间、功能描述、参数说明、修改人、修改时间、修改描述、返回值；上线后每个源码备份空间
附件二、软件需求申请表
附件三、软件开发申请表
附件四、项目组成成员表
项目角色包括项目赞助人（Sponsor）、项目经理（Manager）、项目核心成员（Coreteam）和项目非核心成员（Extendedteam）。
附件五、项目策划/任务书
附件六、WBS表
注：
以上工期及费用估算均用最可能值
附件七、项目进度计划表
附件八、项目风险管理表
附件九、项目沟通计划表
附件十、项目会议纪要
附件十三、项目总结表
升级会员 