财务及企业管理软件开发规范样本.doc

财务及公司管理软件开发规范
文档类别及使用对象
文档类别
该文档是为浪潮软件通用软件公司财务产品部财务产品开发提供一种规范性文献。
使用对象
该文档使用对象为财务产品某些析人员、设计人员、程序员、测试员及项目管理人员和质量保证人员。未经财务产品部负责人允许，该文档不得提供上述规定对象以外人员阅读或使用。
第一章 导言
一、 目
该文档是为财务产品部进行财务软件开发提供规范，其目是：
— 为各类开发、测试文档编写提供原则
— 保证软件实现时有统一原则可参照
— 使产品构造组织方式统一
— 保证软件测试时遵循一定办法及规范
— 可以合理管理及使用公用资源
二、 范畴
本文档描述了财务产品部进行财务软件开发时提供需求规格阐明书、软件设计阐明书原则内容，给出了软件实现过程中所根据原则，软件在测试过程中工作内容，以及公用资源库管理和使用办法。
三、 术语定义
子系统：
模块：

四、 参照资料
[1] 《计算机软件工程规范—国标汇编》
中华人民共和国原则版出版社 1992
[2] 《公司管理信息系统开发指南》
浪潮集团山东通用软件有限公司 1997.8

五、 版本更新记录
版本/修订版
日期
修改记录
备注
1.0
98.10
初始版本

第二章 开发文档规范
第一节 业务流程图
一． 采用工具
采用 VISIO 系列工具。

二． 书写规定
在充分理解顾客业务基本上，采用 VISIO 工具书写流程图。

1． 按某一详细业务形成一种文献。
例如：“采购筹划”流程图存储成一种文献，“采购核算”流程图存储成另
一文献。其中“采购筹划”、“采购核算”是两种详细业务。

2． 文献开始内容，是所描述业务名称。
例如：“采购筹划”流程图文献第一页题目是“采购筹划”。

3． 在文献 Properties 属性中，写明文献“Title”、“Subject”、“Creator”及简朴
描述“Description”。

4． 多页描述
业务内容较多，不能在一页内完整描述时，分页描述。业务起始内容书写在第一页，后来内容放在后页中。

5．页大小普通采用A4纸大小，可以依照不同状况调节。

三． 书写格式
流程图中所涉及不同对象、不同表达方式采用如下规定。

1． 业务名称。 中文书写，字号为14，黑体，居中或左对齐。

2． 各种对象表达符号

制单人
A．人员，例如操作员、记帐员、客户、供应商等，采用圆圈内书写人员方式。

B．判断，例如审核等，采用菱形符号，其判断成果为“Yes”或“No”，并且使
用箭头指出。
Yes
No
审核

记帐
C．操作，例如记帐、材料出入库等，采用矩形符号，其中写明操作方式。

普通来说，操作是由人员执行，执行人在操作左边或上面表达，用箭头连接。
制单人

记帐
记帐
记帐员

输入
D．输入操作，例如单据输入等，采用梯形符号，其中写明操作方式。

E．实物，例如材料、产成品等，采用平行四边形符号，其中写明实物名称。

材料

记帐凭证
销售发票
F．单据，例如入库单、记帐凭证等，采用下面符号，其中写明单据名称。

前者表达一张单据，后者表达多张单据。

存档
G．存档成果，采用下面符号，其中写明操作方式。

3． 表达符号大小及字体规格

各种表达符号不能忽大忽小，应在美观、流畅基本上设立，普通采用如下规格：
圆圈大小直径为2 cm，其她符号横向纵向比例为3：2，既横向为3cm，纵向为
2cm 。固然依照需要进行整体恰当放大。

字体规格：字型为 Arial，字号为10Pt. 可随符号放大，字体增大。

4． 表达符号顺序及连接
依照业务流程，表达符号从左到右排列，之间采用箭头连接，并且箭头两端分别连接符号中间；对于分支连接方式采用树状符号。

No
记帐员
存档
例如：
审核
记帐
帐薄
凭证
录入
制单人

四． 输出规定
在打印输出时，设立打印格式，预留装订线位置。
装订时，按照业务流程从上到下排列纸张顺序。

第二节 类图
一． 使用工具
Rational Rose
二．操作环节
2．1找准对象，将各对象描述信息写好。
2．2画出对象间普通到特殊（继承）、整体到某些（聚簇）、依赖、联系等关系，可以相应相应描述信息。
2．3标记出一对多，多对一关系。
2．4在对象上添上属性，属性类型要表达出来（例如：主键、外键）。
2．5在对象上添加上办法，可相应相应描述信息。
2．6检核对象关系与否合理。
2．7检核对象上办法与否实现了所有功能。
2．8重新抽象对象，重新调节关系。
三．书写规定
在划类图时应坚持如下原则：
3．1类图以清晰表达对象间关系为目，一种系统可画若干类图，一张图可只表达关系紧密几种对象，不一定必要将所有对象放到一张图中表达。
3．2各对象之间关系线，以不交叉为原则。
3． 3对象一定得找全、找准
四、 输出规定
4．1 类图
4．2 rose report （word文挡）

第三节 软件需求规格阐明书
该阐明书应按照如下格式编写，详细如下：
文档类别及使用对象
1．导言
1．1目
阐明编写这份软件需求规格阐明书目。
１. 2范畴
描述本文档所涉及范畴及未涉及内容。
1．3术语定义
列出本文献中用到专门术语定义和外文首字母组词原词组。
1．4参照资料
列出用得着参照资料。
1．5版本更新记录
记录本文档版本更新过程。

2．任务概述
2．1目的
论述该项软件开发意图、应用目的、作用范畴以及其她应向读者阐明关于该软件开发背景材料。解释被开发软件与其她关于软件之间关系。如果本软件产品是一项独立软件，并且所有内容自含，则阐明这一点。如果所定义产品是一种更大系统一种构成某些，则应阐明本产品与系统中其她各构成某些之间关系，为此可使用一张方框图来阐明该系统构成和本产品同其她各某些联系和接口。
2．2顾客特点
列出本软件最后顾客特点，充分阐明操作人员、维护人员教诲水平和技术特长，以及本软件预期使用频度。这些是软件设计工作重要约束。
2．3假定和约束
列出进行本软件开发工作假定和约束，例如经费限制、开发期限等。
3．需求规定
3．1对功能规定
用列表方式（例如IPO图），逐项定量和定性地论述对软件所提出功能规定，阐明输入什么量、经如何解决、得到什么输出，阐明软件应支持终端数和应支持并行操作顾客数。
3．2对性能规定
3．2．1精度
阐明对该软件输入、输出数据精度规定，也许涉及传播过程中精度。
3．2．2时间特性规定
阐明对于该软件时间特性规定，如对：
A．响应时间；
B．更新解决时间；
C．数据转换和传送时间；
D．解题时间；
等规定。
3．2．3灵活性
阐明对该软件灵活性规定，即当需求发生某些变化时，该软件对这些变化适应能力，如：
A．操作方式变化；
B．运营环境变化；
C．同其她软件接口变化；
D．精度和有效时限变化；
E．筹划变化或改进。
对于为了提供这些灵活性而进行专门设计某些应当加以标明。
3．3输入输出规定
解释各输入输出数据类型，并逐项阐明其媒体、格式、数值范畴、精度等。对软件数据输出及必要标明控制输出量进行解释并举例，涉及对硬拷贝报告（正常成果输出、状态输出以及异常输出）以及图形或显示报告描述。
3．4数据管理能力规定
阐明需要管理文卷和记录个数、表和文卷大小规模，要按可预见增长对数据及其分量存储规定作出估算。
3．5故障解决规定
列出也许软件、硬件故障以及对各项性能而言所产生后果和对故障解决规定。
3．6其她专门规定
如顾客单位对安全保密规定，对使用以便规定，对可维护性、可补充性、易读性、可告性、运营环境可转换性特殊规定等。
4．运营环境规定
4．1设备
列出运营该软件所需要硬设备。阐明其中新型设备及其专门功能，涉及：
A．解决器型号及内存容量；
B．外存容量、联机或脱机、媒体及其存储格式，设备型号及数量；
C．输入及输出设备型号和数量，联机或脱机；
D．数据通信设备型号和数量；
E．功能键及其她专用硬件。
4．2支持软件
列出支持软件，涉及要用到操作系统、编译（或汇编）程序、测试支持软件等。
4．3接口
阐明该软件同其她软件之间接口、数据通信合同等。
4．4控制
阐明控制该软件运营办法和控制信号，并阐明这些控制信号来源。

第四节 软件设计规格阐明书
该阐明书应按照如下格式编写，详细如下：
文档类别及使用对象
描述本文档类别、使用对象及使用对象外对象在什么状况下可以使用本文档。
1．导言
1．1目
描述本文档编写目。
1．2范畴
描述本文档所涉及内容范畴。
1．3术语定义
对本文档所涉及某些语述进行解释。
1．4参照资料
描述本文档参照资料
1．5版本更新记录
记录本文档版本更新记录。
2．产品框架构造图
产品框架构造图描述整产品体系构造，应包括如下内容：整个产品体系构造图（模块图），各模块接口关系。

3．软件解决流程图
该流程图应是基于模块。每个模块流程图分主流程图和细化流程图。细化流程图划分原则，以一种独立业务对象或功能对象为根据。
软件解决流程图内容：功能解决流程描述，重要解决办法描述，重要系统参数定义，与其她系统接口描述。

4．功能层次图
是软件完毕需求规格、解决流程详细体现形式。功能层次应与业务流程相相应，以便于在精简或增长业务流程时，从功能层进行相应减少或扩充。重要有以内容：
功能层次图
功能层次图以树状构造描述，功能层次图中，每一项功能都应规定字功能号，这里功能将是在软件实现时进行权限控制及作其他引用功能号，因而在定义时必要遵循规定，这里规定功能号格式如下：
系统编号（两位）+功能层次号（4位）
系统编号规定参见附录；

系统菜单
定义出模块下拉主菜单，各菜单中也要体现中功能号，以便于理解功能层次图同系统菜单各项联系。

5．详细设计
详细设计应基于功能层次图及此前各某些资料，其重要内容涉及界面设计、程序解决流程、办法、阐明等等，是程序员进行程序设计根据。详细内容如下：
——任务编号／名称：作为某一任务标记。
——背景描述：对这一任务背景进行简朴描述。
——涉及数据表（重要／有关）：该任务涉及到重要操作表及有关操作表。
——界面：该任务所用到所有界面描述。
界面中所涉及到项目解释。
——功能、性能：该任务要提供功能及其描述，以及应达到性能规定。
——解决：该任务解决流程。对于简朴任务，可不进行描述。
——重要算法设计：该任务所涉及到重要算法及描述，对于简朴或惯用算法可不必进行描述。
——注意事项：对于某些特别需求注意事项要在此注明。

6．数据构造设计
涉及如下内容：
——表名／辨认名称：任为表标记。
——属性描述：描述该表所有属性及各属性属性，主外键描述等，详细格式如下：
表名
表命名，命名规范
辨认名称
表达意议中文名称
索引
如有各种索引，分别列出
序号
名称
辨认名
类型
空否
缺省
检查
主／外键
备注

主键用ＰＫ表达，外键用ＦＫ表达，如果为外键，则要在备注中指明引用表。该项内容也可以直接从类图生成资料成获得，按原格式即可。
——索引描述：描述该表索引，将所有索引都列示出来，详细格式：
索引：名称［，unique］[,clustered],列名
——涉及办法：该表所涉及操作。
第三章 软件实现规范
第一节 组织方式
产品构造应遵守原则：执行以便、登录简朴、互相联系、风格流行。执行以便是指在顾客在操作时可以很以便操作国强财务软件能中任何一种模块；登录简朴是指顾客在登录国强财务软件时是不需录通过太复杂过程，可以很直接进行系统进行操作；互相联系是指顾客登录进行某一种子系统后，不需要再重新登录就能直接转换到其他子系统下进行操作；风格流行是指产品形式、构造要符合当前流行软件及同类产品中某些先进软件形式和构造。签于以上原则，建议国强财务软件组织方式如下：
国强财务软件按照子系统进行划分，每一种子系统作为一种应用软件，建立一种独立图标，建立国强财务软件组，各子系统图标均在该组内。
各个子系统应用菜单中，应均有一项联接其他子系统菜单。
各个子系统登录方式如下：执行程序时一方面显示一欢迎窗口，该窗口应以简炼、精致、精确反映信息为原则；显示完迎窗口后显示登录窗口，在该窗口中应容许输入登录编号、登录口令、选取帐套，可以新建帐套、新建顾客；登录信息输入对的后进行该套帐进行操作。详细如下图：

主操用界面
登录窗口
显示欢迎信息
执行图标

各子系统操作主画面还是以老式下拉式菜单加TOOL BAR方式，第一行为主操作菜单，第二行为TOOL BAR，最后一行为运营状态。对于各个详细操作功能，也如下拉菜单加TOOL BAR方式进行操作。详细如下：
菜单区

TOOL BAR区

操作区

使用单位
当前日期
会计日期
时间
软件名称
操作员

第二节 命名规范
一、数据库对象命名规范
【目 】
使本产品所有系统既互相联系，又互相独立。既能单独运营于特定数据库，又能同步运营于特定数据库。使所有系统设计人员及程序员在设计数据库对象时有据原则可依。使整个产品不但在界面、风格上一致，在内部构造上也采用相似风格，以利于整个产品共同发展。
【定义内容】
需定义内容涉及所有数据库对象：表、视图、存储过程、触发器及表列。
【命名规则】
前缀+表意名
表意名以中文拼音简写或英文单词。

【详细内容】
1、表
前缀=系统编号
表名最长为13位。
所有字符均以大写字母表达。

如帐务系统中科目字典：
ZWKMZD
如销售中产品字典：
XSCPZD
2、列
前缀=表名_
表意名最长为15位。
所有字符均以大写字母表达。

如科目字典中科目编号：
ZWKMZD_KMBH

3、视图
前缀= vw_
表意串中所有字符均以小写字母表达，表意串即为相应表名。
如帐务中关于专项核算视图：
vw_gszwhszd

4、存储过程
前缀=pr+变量类型
表意串中各意义段第一种字符为大写字母。
如获得两字符串中不同某些存储进程：
prsTwoStr

5、触发器
命名规则不同于以上：
前缀+相应表名+后缀
前缀=tr_
后缀依照触发器性质决定：
插入触发器 _ins
删除触发器 _del
更新触发器 _upt

如：科目字典增长触发器：
tr_gszwkmzd_ins

6、某些表义名构成：
代表意义
标记符
编号
Bh
名称
Mc
金额
Je
数量
Sl
外币
Wb
单价
Dj
汇率
Hl
字典
Zd
明细
Mx
级数
Js

二、PowerBuilder对象命名规范

【目 】
使程序员可以进行无私程序设计，即避免程序员与其所产生代码之间关系过于密切。提高程序代码规范化限度，使程序代码易读易懂，并可以达到程序员之间互相进行程序维护。

【定 义】
变量类型：在本规范中，用于定义变量 PowerBuilder 数据类型和 PowerBuilder
对象类型统称为变量类型。

【命名规则】
所有对象命名皆根据下列规则： 前缀 + 表意字串。
该规则由两某些构成：前缀某些根据不同类型对象进行不同规则定义；表意字串某些普通是指该对象含义或功能描述。含义或功能描述应做到言简意赅，可采用纯中文(指中文拼音首字母)，纯西文及中西结合办法进行描述。
对于 PowerBuilder Controls 名字，不要使用 PowerBuilder提供缺省纯阿拉伯数字，而要使用含义明确表意字串。
变量和对象命字由程序员自由定义，下面命名规范重要是对 PowerBuilder 对象
前缀某些进行规则定义。

【书写原则】
前缀某些皆用小写字母书写；名字某些每一种语义段首字母皆用大写书写，也可以在前缀和表意串之间或表意串各语义段之间如下划线连接。其她字母用小写书写。

【重要内容】
如下为本规范中涉及重要PB对象：
Windows，DataWindows，UserObjects；
PowerBuilder Controls；
Objects in DataWindow；
Functions；
Variables；
暂时表等。

1、Window，DataWindow，UserObject 命名规范
（1） Window
前缀： w_ + 系统名称 + _表意字串
例如： 帐务系统中科目字典维护窗口： w_zw_KmzdWh

（2） DataWindow
前缀： dw_ + 系统名称 + _表意字串
例如： 帐务系统中科目字典数据窗口(查询用)： dw_zw_KmzdWh_cx
(增长删除修改用)：dw_zw_KmzdWh_Update

（3） UserObject
前缀：uo_ + 系统名称 + _ 或者
u_ + 系统名称 + _
例如：可经 PowerBuilder 直接调用 Windows 函数集对象：
u_pub_WinFunc

（4） 系统名称代码见后

2、PowerBuilder Controls
PowerBuilder Controls 前缀普通采用 PowerBuilder 提供缺省前缀，不采用其提供。
（1） CheckBox
前缀： cbx_
（2） CommandButton
前缀： cb_

对重要 CommandButton 名字定义：
按 钮
命 字
确 认
cb_ok
重 试
cb_Retry
取 消
cb_Cancel
退 出
cb_Exit
是
cb_Yes
否
cb_No
增 加
cb_Add
删 除
cb_Del
查 询
cb_Cx
打 印
cb_Print
排 序
cb_Sort
条件查询
cb_Tjcx
更新存盘
cb_Update
页 首
cb_PgFirst
页 尾
cb_PgLast
前 页
cb_PgPrior
后 页
cb_PgNext
前一行(<<)
cb_LPrior
下一行(>>)
cb _LNext
帮 助
cb_Help

（3） DropDownListBox
前缀： ddlb_
（4） EditMask
前缀： em_
（5） Graph
前经： gr_
（6） GroupBox
前缀： gb_
（7） HScrollBar
前缀： hsb_
（8） Line
前缀： l_
阐明： 对于不同型号直线可用不同前缀，如：
(1) 粗横向直线 chl + n (n=1,2,3...)
(2) 粗纵向直线 czl + n
(3) 细横向直线 xhl + n
(4) 细纵向直线 xzl + n

（9） ListBox
前缀： lb_
（10） MultiLineEdit
前缀： mle_
（11） OLE 2.0
前缀： ole_
（12） Oval
前缀： o_
（13） Picture
前缀： p_
（14） PictureButton
前缀： pb_
（15） RadioButton
前缀： rb_
（16） Rectangle
前缀： rt_
（17） RoundRectangle
前缀： rrt_
（18） SingleLineEdit
前缀： sle_
（19） StaticText
前缀： st_
（20） VScrollBar
前缀： vsb_

3、 Objects In DataWindow
如果没有必要，可以不对 DataWindow 中对象进行命名。如果有必要，则需按下面阐明规则命名。

DataWindow 中 Objects 前缀命名办法是：

对象所在区域 + 对象代码 + _

对象所在区域有四个，它们是：Header，Detail，Summary，Footer

下面分别给出前缀定义:

（1） Text
前缀：t_
(1) Text in Header： ht_
(2) Text in Detail： dt_
(3) Text in Summary： st_
(4) Text in Footer： ft_

（2） Computed Field Definition
前缀：c_

特殊 Computer Field 前缀定义：
A) Page Definition
(1) Page in Header： hpg_
(2) Page in Detail： dpg_
(3) Page in Summary： spg_
(4) Page in Footer： fpg_
B) Date Definition
(1) Date in Header： hda_
(2) Date in Detail： dda_
(3) Date in Summary： sda_
(4) Date in Footer： fda_
C) Sum Definition
(1) sum in Header： hsum_
(2) sum in Detail： dsum_
(3) sum in Summary： ssum_
(4) sum in Footer： fsum_

（3） Graph
前缀：gr_
(1) Graph in Header： hgr_
(2) Graph in Detail： dgr_
(3) Graph in Summary： sgr_
(4) Graph in Footer： fgr_
（4） Report
前缀：rp_
(1) Report in Header： hrp_
(2) Report in Detail： drp_
(3) Report in Summary： srp_
(4) Report in Footer： frp_

（5） Extended Bitmap
前缀：bm_
(1) Bitmap in Header： hbm_
(2) Bitmap in Detail： dbm_
(3) Bitmap in Summary： sbm_
(4) Bitmap in Footer： fbm_
（6） Rectangle
前缀：rt_
(1) Rectangle in Header： hrt_
(2) Rectangle in Detail： drt_
(3) Rectangle in Summary： srt_
(4) Rectangle in Footer： frt_
（7） Line
前缀：l_
阐明： 对于不同型号直线可用不同前缀，如：
(1) 粗横向直线 h(d,s,f)chl + n (n=1,2,3...)
(2) 粗纵向直线 h(d,s,f)czl + n
(3) 细横向直线 h(d,s,f)xhl + n
(4) 细纵向直线 h(d,s,f)xzl + n
（8） Oval
前缀：ov_
(1) Oval in Header： hov_
(2) Oval in Detail： dov_
(3) Oval in Summary： sov_
(4) Oval in Footer： fov_
（9） Round Rectangle
前缀：rr_
(1) Round Rectangle in Header： hrr_
(2) Round Rectangle in Detail： drr_
(3) Round Rectangle in Summary： srr_
(4) Round Rectangle in Footer： frr_

（10） Column
Column 名字与表列名同样.

4、 Function（函数）

前缀=可调用范畴 + 返回值变量类型

可调用范畴如下：
可调用范畴
代码
注 释
全程（系统）
g

Window 内部
w

UserObject 内部
u

返回值变量类型为数据类型或对象代码。

例如： gsGetWholeKmmc() 是获得科目全称函数 ，合用整个Appacation ，返回值为字符串型（科目名称）。
例如： wiRjzSl() 是窗口 w_zw_rjzycx 中形成数量日记帐函数。

数据类型或对象类型代码见附录：

5、 Variable（变量）

前缀=变量作用域 + 变量类型

例：
变量名 作用域 变量类型 名字含义或功能
------------------------------------------------------
isKmmc Instance String 科目名称
iiRealKmjs Instance Integer 某总帐科目实际级数
vsSql Script String 动态 SQL 语句
vdJfjeHj Script Double 借方金额共计
vwMain Script Window 模块中用到主窗口变量
gtSqlca Global Transaction定义另一种全程SQLCA
------------------------------------------------------

对惯用变量规定：
(1) 循环计数变量
循环计数变量由于应较频繁，不按上面规则命名，只定义五个（即一种循
环体至多能嵌套四次），使用时由前至后：
i，j，k，m，n

(2) 暂时变量
关于暂时变量概念定义见《PowerBuilder 程序设计风格》一节。

定义： v + 变量类型 + Temp 或者是
v + 变量类型 + Oper(ate) （ate 可省略不写）
例：
viTemp，vsTemp，vdTemp // Integer,String,Double
viOper，vsOper，vdOperate

(3) 其她变量
i) 普通 SQL 语句用变量 vsSql 表达。

(4) PowerBuilder 中浮点数应定义成 Double，不能定义成 real，decimal 等类型。

5、暂时表
暂时表命名规则不同于以上PB对象命名规则，它特殊遵循如下原则：
(1) 名字构成
#+系统名称+表内容及操作描述 ( + 顾客标记号 )
1+ 2 + 6 + 4 = 13(位)
(2) 暂时表表名皆用小写字母表达
(3) 暂时表名字总长度不超过 13 位

例：
总帐余额查询： #zw_zzye1234
日记帐页查询： #zw_rjzy1234

6、代码定义表
（1）数据类型代码
数据类型
代码
注 释
Blob
bl

Boolean
b

Char
c

character
c

Date
da

DateTime
da

Decimal
de

Dec
de

Double
d

Integer
i

Int
i

Long
l

Real
r

String
s

Time
t

UnsignedInteger
ui

UnsignedInt
ui

UInt
ui

UnsignedLong
ul

ULong
ul

（2） 对象类型代码
对象名称
代码
注 释
Application
ap

Structure
st

Menu
m

Window