MIS开发小组文档书写规范第一部分.docx
《MIS开发小组文档书写规范第一部分.docx》由会员分享，可在线阅读，更多相关《MIS开发小组文档书写规范第一部分.docx（22页珍藏版）》请在冰点文库上搜索。
MIS开发小组文档书写规范第一部分
MIS开发小组文档书写规范
内部资料，请勿外传
2006-12-09
第一部分开发文档格式
为了使大家书写格式统一，便于合成。
建议大家都使用下面格式：
一、页面设置
1．上下左右，均为2.5cm;
2．页眉页角均设置为0
二、文档内容
1．标题黑体三号
2．一级标题（如二、正文）使用宋体四号加粗
3．二级标题宋体四号不加粗
4．三级标题及正文宋体小四
5．图的表示如图2.1楷体小四
6．表的标题表示如表三楷体小四
表内文字楷体小四
暂做如上设置，如有变动，再通知。
第二部分控件前缀及数据库命名规则
一、控件对象命名前缀命名规则
表2-1控件对象名称前缀
控件
控件对象名称前缀
DataGrid
DataList
Label
TextBox
Button
LinkButton
HyperLink
Panel
CheckBox
DropDownList
ImageButton
RadioButton
RequireFieldValidator
CompareValidator
RangeValidator
RegularExpressionValidator
ValidatorSummary
dgd
dlt
lbl
tbx
btn
lbtn
hlk
pnl
cbx
ddlt
imbtn
rbtn
rfv
cv
rv
rev
vs
如：
按钮控件:
btn_Submit
标签控件：
lbl_Name
图片按钮控件：
imbtn_Select
二、数据库字段及常用操作命名规则
表2-2数据库及表的内容命名规则
数据库及表的内容
命名规则
例子及注意事项
数据库名称
能说明数据内容的名称
如教务管理数据库：
JiaoWuManage,而不用JiaoWuManageDataBase，DataBase为多余文字
数据库表的名字
能说明数据内容的名称
如学生表用：
Student,而不用StudentData或StudentDiagram，Data或Diagram为多余文字
数据库表的字段
用最短的而又能说明含义的词或组合表示
如学生表Student中,学生的ID：
ID；学生姓名：
Name；学生年龄：
Age；学生所在班级：
ClassID；等等
两个表的关系表名字
用两个表的名字中间加下划线组合表示
如学生和老师的关系表：
Student_Teacher
表2-3数据库表的常用操作命名规则
操作
说明
例子及注意事项
查找或选择
从表中选择一条或多条记录
如在学生表Student中查找或选择一条或多条记录：
Student_select
插入
往表中插入一条或多条记录
如往学生表Student插入一条记录：
Student_insert
更新
在表中更新一条或多条记录
如在学生表Student中更新一条或多条记录：
Student_update
删除
从表中删除一条或多条记录
如从学生表Student中删除一条或多条记录：
Student_delete
根据条件查找
从表中查找一条或多条记录
如在学生表Student中根据学生年龄查找或选择一条或多条记录：
Student_selectByAge
注：
在命名时要一定要用与业务有关的词来命名数据库。
第三部分文档种类
文档贯穿项目的始终，是项目开发中不可或缺的一部分，它是项目开发的依据。
文档主要有以下几类：
需求分析文档、系统设计文档、数据库设计文档、类设计文档、界面设计文档、模块功能及错误代码分段文档、其他文档等。
下面介绍各类文档的内容。
一、需求分析文档
按照用户业务需要写出需求分析文档，包括总体介绍，功能模块，界面，注意事项等。
有时在功能的实现上，要考虑到权限问题，那些功能可以让那些权限的用户操作。
这些都要写成详细的文档。
详细实例见第四部分—需求分析。
二、系统设计文档
系统设计文档是重要的内容之一，它的设计好坏直接关系到系统的合理性、健壮性。
也体现出一个系统分析设计人员的总体把握能力。
系统设计需要紧密结合用户需求，设计合理精简的系统。
主要包括内容：
总体设计、详细设计、基本资料等。
详见第五部分—系统设计。
三、数据库设计文档
数据库设计时，仔细思考，设计合理的数据库，并写出数据库设计文档，内容包括实体-关系图（E-R图），各个表的详细说明，各个字段的名称、数据类型、长度、缺省值、是否允许空、是否主键、备注等。
具体可以参考FTP上的例子。
注意一点：
在数据库表及字段命名时，要用与业务有关的词，不要用那些与业务无关、无实际含义的词。
详见第六部分—数据库设计
四、类设计文档
类是具体实现业务逻辑功能的。
不仅要实现类的功能，类的属性、方法以及参数名称等都要用能反映其含义的词汇。
便于使用者理解。
在业务逻辑类设计中，注意以下方面：
类中的public方法必须写成虚函数，并有与其相互对应的protected函数，
即publicvirtual函数和protected函数（protected函数名为publicvirtual函数名前加“F_”）。
其中publicvirtual函数功能是判断当前用户是否拥有权限，如没有权限则抛出异常，否则调用相对应的protected函数；而protected函数则实现具体的功能。
具体文档设计见第七部分--类设计。
注意：
在类中要定义public常量m_MoudleID；
示例：
publicconstintm_MoudleID=3;//当前Moudle的ID值
publicvirtual和protected两个函数实现可以参考附加例子Bulletin.cs。
五、界面设计文档
界面是呈现给用户的看的，也是用户操作的平台，一定要实用、合理、美观。
一般界面设计用MicrosoftVisio或RationalRose等设计工具。
在界面设计文档中，要有设计的界面，界面中一些控件或功能的实现，需要注意的问题等。
具体文档实例见第八部分--界面设计。
六、模块功能及错误代码分段文档
在业务逻辑类实现等代码编写过程中，不可避免的涉及到模块功能模块或者需要抛出错误异常。
为了功能模块和错误异常的管理方便，需要对模块功能及错误异常进行分段管理。
这样在设计文档时，就需要有模块功能及错误代码文档。
具体实例可以参见第九部分—模块功能及错误代码分段文档。
七、其他文档
在整个项目中，可能还需要一些其他的文档，可以根据项目需求自己编写。
第四部分需求分析
需求分析文档描述的是用户的需求，要能简洁清楚地说明问题。
特列举一实例如下。
一、问题提出
需要完成一个功能模块----公告，主要是用来实现单位中信息的发布。
二、需求分析
根据如上问题，对公告模块进行如下分析。
1.Bulletin模块介绍：
公告模块分2个子模块：
普通公告、紧急公告。
公告文件类型分为系统公告和非系统公告。
系统公告是包含有该子模块的项目都可以看到的，非系统公告只能在发布它的项目中看到。
每一个子模块独立的部分，与项目无关。
但它们可以出现在每一个项目中，如果权限相同，项目中看到的系统公告是一样的。
2.Bulletin模块主要功能：
每一个子模块都有添加、查看、编辑和删除公告的操作。
每个操作如果没有相应的权限则不能操作。
详细说明：
1.添加操作：
输入公告的标题、公告内容。
并可选择是否系统公告，如果是系统公告，可以选择发送目标项目，且至少选择一个目标项目。
非系统公告不用选择目标项目。
2.查看操作：
可以查看该公告的详细信息，包括公告标题、公告内容、发布人、发布日期、最后修改人、最后修改日期、是否系统公告等。
3.编辑操作：
通过修改公告标题、公告内容及公告发送目标项目（如果是系统公告的情况下）等实现对某公告的修改。
注：
不可以更改是否为系统公告。
4.删除操作：
删除某一个公告。
3.Bulletin模块页面：
1.公告列表显示页面（Bulletin.aspx）。
2.添加公告页面（AddBulletin.aspx）。
3.查看单个公告详细信息页面（ShowBulletin.aspx）。
4.修改单个公告信息页面（EditBulletin.aspx）。
第五部分系统设计
系统设计主要描述整个系统的总体设计和各个子系统的详细设计。
并对整个系统中的各种定义做明确阐述。
第六部分数据库设计
根据需求分析，该模块用两个表就可以实现。
一、数据库表
数据表一：
公告
数据库表名[Bulletin]
名称
数据类型
长度
缺省值
允许空
主键
注释
ID
Int
4
自增
N
Y
公告ID
ItemModuleID
Int
4
N
项目模块ID
Cate
Tinyint
1
N
公告类别
Title
Varchar
200
N
公告主题
Content
Text
16
N
公告内容
PublishTime
Datatime
8
N
发布时间
UserID
Int
4
N
用户ID
UserName
Varchar
50
N
用户名称
UnitID
Int
4
N
单位ID
UnitName
Varchar
50
N
单位名称
ModifyUserID
Int
4
Y
修改人ID
ModifyUserName
Varchar
50
Y
修改人名称
LastModifiedTime
Datatime
8
Y
最后一次修改时间
IP
Varchar
20
N
发布或更改的IP地址
数据表二：
项目模块公告表
数据库表名[Bulletin_ItemModule]
名称
数据类型
长度
缺省值
允许空
主键
注释
ID
Int
4
自增
N
Y
ID
BulletinID
Int
4
N
公告ID
ItemModuleID
Int
4
N
系统模块ID
第七部分类设计
一、类设计
1.设计类框图
类设计使用工具PowerDesigner。
首先设计类框图，详细写出类的名称、属性以及方法。
在设计过程中，选择“文件”下“新建”ObjectOrientedModel，再在该Model下新建Class，就可以进行编辑。
在PowerDesigner设计中通过双击类图（或单击右键），可以看到对类进行编辑的界面（或操作）。
选择“Attributes”选项卡可以对属性进行编辑。
选择“Operations”选项卡可以对方法进行编辑。
也可以选择“Preview”选项卡直接进行代码编写。
如下图。
这两种方法效果是一样的。
这样就可以完成简单的类图设计。
2.类的详细描述
在设计完类框图之后，要对类进行详细描述。
包括类的名字、类型、包含方法以及方法的名称、类型、输入参数、输出参数、功能描述都进行简洁详细的说明。
如果哪个方法调用了存储过程，返回DataSet类型的数据列表。
就把存储过程名列出，并写明返回的数据列表的各列及列的说明。
每次对类进行更新的时候，要对相应的类图和类的详细描述都进行更新。
并注明更新时间、更新内容及更新人等。
图5.2设计类框图类属性
示例如下：
图5.3User类
User类（假设该类是类设计中的第五个类）
名称：
publicclassUser
类型：
public
方法：
5.1名称：
publicUser（ObjectUserState）
类型：
public
输入参数：
ObjectUserState
输出参数：
无
功能描述：
//构造方法。
传入Object类型对象UserState。
用于初始化用户当前状态信息。
其中，Object类型包含状态信息为：
用户所在Item,Unit,拥有Role,Function用户名，ID等。
并且这些信息只在login时初始化，以后就是只读的。
不能进行修改。
5.2名称：
publicvoidUpdateUser（intUserID,stringLoginName,stringPassword,stringName,intSex）
类型：
public
输入参数：
intUserID,
stringLoginName,
stringPassword,
stringName,
intSex
输出参数：
无
功能描述：
//更新用户信息。
调用此方法，传入参数UserID,LoginName,Password,Name,Sex，更新一个用户信息。
无返回值。
5.3名称：
publicDataSetSearchUser（intItemID,intUnitID,stringLoginName,stringName,intSex）
类型：
public
输入参数：
intItemID,
intUnitID,
stringLoginName,
stringName,
intSex
输出参数：
DataSet型用户列表
功能描述：
//查询符合模糊查询的用户用户。
调用此方法，传入参数ItemID,UnitID,LoginName,Name,Sex，显示符合模糊查询的用户。
返回DataSet型用户列表。
调用存储过程User_select
返回DataSet共1表共2列。
列1：
ID说明：
User表的ID
列2：
NameUser表的Name
列3：
LoginNameUser表的LoginName
列4：
SexUser表的Sex
5.4名称：
publicvoidDeleteUser（intUserID）
类型：
public
输入参数：
intUserID
输出参数：
无
功能描述：
//删除用户。
调用此方法，传入参数UserID，删除一个ID为UserID的用户。
无返回值。
属性：
privateObjectUserState;
如若对类进行修改，要作如下注释（示例）：
注：
1.2006-03-23最新更新用红色标记;
publicUser（ObjectUserState）去掉一个参数ItemID;
publicDataSetSearchUser（intItemID,intUnitID,stringLoginName,stringName,intSex）增加一个参数intItemID；
2.2006-03-26最新更新用紫色标记;增加如下方法：
publicvoidDeleteUser（intUserID）；
更新人：
陈占芳
第八部分页面设计
一、页面设计
页面设计使用工具MicrosoftVisio。
首先设计页面，确定页面的名字,对页面的主要作用进行描述。
并对页面控件功能及页面之间的跳转进行说明。
设计页面时，在“文件”下“模具”中找到“Windows用户界面”，主要控件都可以在此找到。
然后就可以进行页面设计。
也可以从其它模具中用需要的控件。
图5.1项目管理页面（ItemManagement.aspx）
说明一：
在没有创建第一个项目分类前，该页面的已创建项目分类列表为空。
只能创建项目分类。
当创建项目分类之后，就可以显示已创建的项目分类。
并可以在项目分类列表中添加具体项目。
在项目分类列表中可以对项目分类进行修改，删除和移动顺序的操作。
同样，在项目列表中可以对项目进行修改，删除和移动顺序的操作。
在图1中点击项目类型“修改”按钮，修改项目类型名称。
点击项目“修改”按钮，。
修改项目名称。
“添加”、“修改”、“删除”和“移动顺序”按钮都不调转页面，只在本页面刷新显示。
第九部分模块功能错误代码分段
对M（odule）、F（unction）、E（rr）M（essage）等的代码分段，都有一个区间的数字作为代号。
详细情况见下表：
一.个人工作类别（没有F（unction））
（一）模块模板表
1.个人工作类别
序号
模块名称
命名空间
错误代码区间
备注
1
短消息
OA.ShortMessage
2010101-2019999
7位错误代码
2
记事本
OA.NotePad
2020101-2029999
3
通讯录
OA.AddressBook
2030101-2039999
（二）模块错误代码表（EM）
1.记事本（OA.NotPad）
序号
错误代码
错误消息
详细信息
备注
1
2020101
记事本
7位错误代码
2.短消息（OA.ShortMessage）
序号
错误代码
错误消息
详细信息
备注
1
2010101
7位错误代码
2
2010102
3
2010201
4
2010202
5
2010203
6
2010204
7
2010205
3.通讯录（OA.AddressBook）
序号
错误代码
错误消息
详细信息
备注
1
2030101
2
2030102
3
2030201
4
2030202
5
2030203
6
2030204
说明：
1.代码区间：
2010101-2019999的意义：
其中红色“2”代表模块模板，一位数1-9；“201”表示该模块模板下的一个模块。
蓝色“01”代表功能操作代码，两位数01-99。
表示操作下的功能操作；
紫色“01”、“99”表示某一功能下的错误代码。
2.每人按照例子根据自己的模块具体填写表格。
3.错误代码就按错误代码表中的例子写。
二．可查看信息类别（有权限的模块）
（一）模块模板表
序号
模块名称
命名空间
功能代码区间
备注
1
信息发布
OA.Information
310101-319999
6位Function码
2
工作日程
OA.Schedule
330101-339999
6位Function码
（二）模板功能代码表
1.信息（OA.Information）
序号
功能名称
功能代码
备注
1
查看信息
310100
6位Function码
2
查看系统信息
310101
3
查看同项目信息
310102
4
查看同级单位信息
310103
5
查看上级单位信息
310104
6
查看直接上级单位信息
310105
7
查看本单位信息
310106
8
查看直接下级单位信息
310107
9
查看下级单位信息
310108
10
管理信息
310200
11
管理系统信息
310201
12
管理同模板信息
310202
13
管理同级单位信息
310203
14
管理上级单位信息
310204
15
管理直接上级信息
310205
16
管理本信息
310206
17
管理直接下级信息
310207
2.工作日程（OA.Schedule）
序号
功能名称
功能代码
备注
1
查看工作日程
330100
6位Function码
2
查看系统工作日程
330101
3
查看同项目工作日程
330102
4
查看同级单位工作日程
330103
5
查看上级单位工作日程
330104
6
查看直接上级单位工作日程
330105
7
查看本单位工作日程
330106
8
查看直接下级单位工作日程
330107
9
查看下级单位工作日程
330108
10
管理工作日程
330200
11
管理系统工作日程
330201
12
管理同模板工作日程
330202
13
管理同级单位工作日程
330203
14
管理上级单位工作日程
330204
15
管理直接上级工作日程
330205
16
管理本工作日程
330206
17
管理直接下级工作日程
330207
（三）错误代码表
1.信息相关错误（OA.EM）
序号
错误信息（Message）
错误代码
错误描述
1
查看信息
31010001
无查看信息权限
2
查看系统信息
31010101
无查看系统信息权限
3
查看同项目信息
31010202
无查看项目信息权限
4
查看同级单位信息
31010303
无查看同级单位信息权限
5
查看上级单位信息
31010404
无查看上级单位信息权限
6
查看直接上级单位信息
31010505
无查看直接上级单位信息权限
7
查看本单位信息
31010606
无查看本单位信息权限
8
查看直接下级单位信息
31010707
无查看直接下级单位信息权限
9
查看下级单位信息
31010808
无查看下级单位信息权限
10
管理信息
31020001
无管理信息权限
11
管理系统信息
31020101
无管理系统信息权限
12
管理同模板信息
31020202
无管理同模板信息权限
13
管理同级单位信息
31020303
无管理同级单位信息权限
14
管理上级单位信息
31020404
无管理上级单位信息权限
15
管理直接上级信息
31020505
无管理直接上级信息权限
16
管理本单位信息
31020606
无管理本单位信息权限
17
管理直接下级信息
31020707
无管理直接下级信息权限
18
2.工作日程相关错误（OA.EM）
序号
错误信息（Mes）
错误代码
错误描述（Det）
1
查看工作日程
33010001
2
查看系统工作日程
33010101
3
查看同项目工作日程
33010202
4
查看同级单位工作日程
33010303
5
查看上级单位工作日程
33010404
6
查看直接上级单位工作日程
33010505
7
查看本单位工作日程
33010606
8
查看直接下级单位工作日程
33010707
9
查看下级单位工作日程
33010808
10
管理工作日程
33020001
升级会员 