信息系统软件开发流程管理规范初稿Word格式.docx
《信息系统软件开发流程管理规范初稿Word格式.docx》由会员分享，可在线阅读，更多相关《信息系统软件开发流程管理规范初稿Word格式.docx（19页珍藏版）》请在冰豆网上搜索。
及时反馈结果给需求部门；
II、指导需求部门填写各类表格；
III、积极评审需求部门填写的表格、积极沟通，有效获得相对准确的需求，并填写完善，
让需求部门签字确认；
IV、进入开发流程后，积极填写《项目成员组成表》、《项目策划任务书》、《WBS表》、
《项目进度计划表》等（具体见附件）；
V、积极开展人员培训和软件试用工作，编写完善的《XXX软件试用说明书》，并要求相关人员签字确认，并存档处理。
三、附件附件一、编码规范1、命名空间
1.公共类库（公司功能业务）：
（1）全局公共类库：
例：
生成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
j）List集合：
功能名称首字母小写+驼峰+Listk）字典：
功能名称首字母小写+驼峰+Dic
l）Dateset：
功能名称首字母小写+驼峰+Dsm）DateTable：
功能名称首字母小写+驼峰+Dt
附表1：
类型前缀（小写）+驼峰样式名词或名词短语对于基本类型变量，前缀如下表：
类型
前缀
int
double
dou
float
fl
string
str
bool
datetime
dat
byte
byt
......
对于对象类型变量，也可以采用类似基本类型方式，如StringBuilder类型，可使用sb作为前缀开头，后跟变量名驼峰样式。
对于集合类型变量，如数组、List、Dictionary，可以在变量命名的基础上结尾加入集合类型简写。
如，sqlList，dataDic等。
2.2数据库表命名规则
命名方法：
项目大写首字母+_+功能（全英文大写）
【多单词组成的，取单词首字母大写组合】表字段：
类似变量命名
索引:
表名（或缩写）+_+列名+idx注：
ID、创建人（creator）、创建时间（createTime）、状态（state）、创建人工号（createID）等字段为必须创建的字段;
3、代码规范
3.1代码分层结构
建议每个模块中代码至少分三层结构,根据项目大小决定是否采用这种方式,可以先以一两个项目测试一下这种结构;
例如一个项目的一个模块，可以创建文件夹结构如下所示：
表现层直接面向用户，逻辑层负责后端逻辑处理，数据层负责和底层数据库交互。
表现层调用逻辑层代码，只有查询数据时，表现层可以直接调用数据层；
逻辑层负责处理逻辑，为表现层提供调用接口，其数据操作需要调用数据层提供接口；
数据层负责提供和处理数据，需要为逻辑层提供调用接口，所有与数据库的操作都只能在该层实现。
3.2编码规范
3.2.1通用
a）类功能必须唯一：
每个文件中只有一个类（不包括内部类）
b）行宽限制在80个字符内，必须按最低优先级换行
c）方法代码限制在200行内
d）类代码建议限制在1500行内
e）方法参数过长，应分行显示，逗号至于末尾
f）每行声明一个变量，且尽量赋初值，同类型必须连续写
g）复合语句都需加大括号{}，不要写在一行，if、else尽量配对出现，try、catch、finallyh）高扇入、合理扇出（尽量不超过三层）
i）缩进不允许空行
j）递归要慎用，goto不允许使用
k）方法内禁止更改传递过来的参数
l）实体类中变量应私有化，应包含每个变量的set及get方法
m）避免三层以上嵌套循环
n）代码应包含正确性和容错性处理（try、catch、finally）
o）编程时应考虑代码的效率（时间、空间），多循环内侧，变量声明放在循环外
p）对象比较用对应方法不用“==”，例如：
equals，comparetoq）计算尽量避免除法
r）设计方法可重用性
s）else、finally、catch、日志必须有出口t）堆常量统一定义，避免用常量字符串u）变量必须初始化
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手工添加注释
创建新对象可以手工添加注释：
注释写法：
块注释注释包含在/*和*/中，可以有多行。
行注释
以//开头，可以有多行，每行前面都以//开头。
文件头注释
/*==============================================================================
*Copyright?
2013ECOVACSInc.Allrightsreserved!
*科沃斯机器人科技（苏州）有限公司
*
==============================================================================*/
类文件注释
/*
*DESC:
类功能描述
*SINCE:
.net版本
*CREATOR:
创建人
*DATE:
创建日期
**/
方法注释
方法功能描述
*PARAMS:
参数说明
*RETURN:
返回值说明
4.3注释要求
a）注释量：
20%~30%，项目完成周期延长20%b）注释地方：
段前以及当行之后
c）上线之前无需版本号，上线之后需版本号，上线前统一为1.0d）注释与自身方法之间不为空，其他方法必须为空
e）注释代码在上线后全删除，上线后不允许无效代码存在注：
注释中的内容含创建人、创建时间、功能描述、参数说明、修改人、修改时间、修改描述、返回值；
上线后每个源码备份空间
附件二、软件需求申请表
需求部门：
申请人：
用途描述
目前工作状态
基本功能描述
部门主管建议
签字确认
（时间）
附件三、软件开发申请表
具体功能模块说明
目前工作流程
项目完成所能带来的预期效益（可节省的人力、物力等）
附件四、项目组成成员表
一、项目基本情况
项目名称（ProjectName）：
项目编号（ProjectCode）：
制作人（Preparedby）：
审核人（Reviewedby）：
项目经理（ProjectManager）：
制作日期（Data）：
二、项目组成员
成员姓名
Name
项目角色
ProjectRole
所在部门
DeptName
职责
Responsibility
项目起止日
期Data
投入频度及
工作量Time
联系电话
TelNo.
主管经理
Supervisor
签字Signature：
日期Date：
项目赞助人Sponsor
项目经理ProjectManager
项目角色包括项目赞助人（Sponsor）、项目经理（Manager）、项目核心成员（Coreteam）和项目非核心成员（Extendedteam）。
附件五、项目策划/任务书
二、项目描述
1、项目背景与目的（所有的项目均起始于某个商业问题，该部分简要描述这些问题）
2、项目目标（包括质量目标，工期目标、费用目标和交付产品特征与特征的主要描述）
3、项目里程碑计划（包含里程碑的时间和成果）
4、评价标准（说明项目成果在何种情况下将被接受）
5、项目假定与约束条件（说明项目的主要假设条件和限制性条件）
6、项目主要利益干系人（包括高管、客户、职能部门主管、供应商、项目赞助人、项目经理、项目组成成员等干系人）
姓名
类别
部门
职务
附件六、WBS表
二、工作分解结构
分解代码
WBSCode
任务名称
Task
包含活动
ActivitiesIncluded
工时估算
EstimatedTime
人力资源
EstimatedHR
其他资源
EstimatedResources
费用估计
EstimatedCost
工期
ExpectedDays
注：
以上工期及费用估算均用最可能值
附件七、项目进度计划表
二、项目进度表
周（Week）
1
2
责任人
TeamMemmber
关键里程碑Milestone
开始
Start
29
3
4
5
6
7
8
9
开工会Kick-offmeeting
附件八、项目风险管理表
二、项目风险管理
风险发生概率的判断准则
高风险：
>
60%发生风险的可能性
中风险：
30-60%发生风险的可能性
低风险：
<
30%发生风险的可能性
序号
SequenceNO.
风险描述
RiskDescription
发生概率
HappeningProbability
影响程度
Influencedegree
风险等级
RiskLevel
风险响应计划
RiskResponsePlan
Riskowner
开放/关闭
Open/Closed
附件九、项目沟通计划表
二、项目沟通计划
利益干系人
Stakeholders
所需信息
InfoNeeded
频率
Frequency
方法
Means
附件十、项目会议纪要
一、基本情况
会议名称（MeetingName）：
召集人（CalledBy）：
会议日期（MeetingDate）：
开始时间（StartTime）：
会议地点（MeetingPlace）：
持续时间（MeetingDuration）：
记录人（MinutesBy）：
审核人（ReviewedBy）：
二、会议目标
简要说明会议的目标，包括期望达到的结果
三、参加人员（列出参加会议的人员，他在项目中的头衔或角色）
四、发放材料（列出会议讨论的所有项目资料）
五、发言记录（记录发言人的观点、意见和建议）
六、会议决议（说明会议结论）
七、会议纪要发放范围
附件十一、项目状态报告表
当前项目状况
□按计划进行
□比计划提前
□落后计划
汇报周期
二、当前任务状态（简要描述任务进展情况）
关键人物
状态指示
状态描述
三、本周期内的主要活动（对本周期内的主要交付物进行总结）
四、下一个汇报周期内的活动计划（描述活动需要与项目计划和WBS相对应）
五、财务状况
六、上期遗留问题的处理（说明上一个汇报周期内问题的处理意见和处理结果）
七、本期问题与求助
附件十二、项目变更管理表
二、历史变更记录
（按时间顺序记录项目以往的每一次变更情况）
变更时间
ChangeDate
涉及项目任务
TaskConcerned
变更要点
ChangeTo
变更理由
WhyRequested
申请人
RequestedBy
审批人
ApprovedBy
三、请求变更信息
（建议的变更描述以及参考资料）
1、申请变更的内容
2、申请变更原因
四、影响分析
受影响的基准计划
1、进度计划
2、费用计划
3、资源计划
是否需要成本/进度影响分析？
□是
□否
对成本的影响
对进度的影响
对资源的影响
变更程度分类
□高
□中
□低
若不进行变更有何影响
申请人签字
申请日期
五、审批结果
审批意见
审批人签字
日期
附件十三、项目总结表
二、项目完成情况总结
1、时间总结
开始时间：
StartDate
计划完成时间
ExpectedFinishDate
实际完成日期
ActualFinishDate
时间（差异）分析
2、成本总结
计划费用
实际费用
成本（差异）分析
3、交付结果总结
计划交付结果
实际交付结果
未交付结果
交付结果（差异）分析
三、项目经验、教训总结
签字Signature
日期Date
项目赞助人ProjectSponsor
升级会员 