财务及企业管理软件开发规范

1财务及企业管理软件开发规范文档类别及使用对象文档类别该文档是为浪潮软件通用软件公司财务产品部财务产品开发提供一个规范性文件。使用对象该文档的使用对象为财务产品部分析人员、设计人员、程序员、测试员及项目管理人员和质量保证人员。未经财务产品部负责人许可，该文档不得提供上述规定对象以外的人员阅读或使用。第一章导言一、目的该文档是为财务产品部进行财务软件开发提供的规范，其目是：—为各类开发、测试文档的编写提供标准—保证软件实现时有统一的标准可参照—使产品结构的组织方式统一—保证软件测试时遵循一定的方法及规范—能够合理的管理及使用公用资源二、范围本文档描述了财务产品部进行财务软件开发时提供的需求规格说明书、软件设计说明书的标准内容，给出了软件实现过程中的所依据的标准，软件在测试过程中工作内容，以及公用资源库的管理和使用办法。三、术语定义子系统：模块：2四、参考资料[1]《计算机软件工程规范—国家标准汇编》中国标准版出版社1992[2]《企业管理信息系统开发指南》浪潮集团山东通用软件有限公司1997.8五、版本更新记录版本/修订版日期修改记录备注1.098.10初始版本第二章开发文档规范第一节业务流程图一．采用工具采用VISIO系列工具。二．书写规定在充分了解用户业务的基础上，采用VISIO工具书写流程图。1．按某一具体的业务形成一个文件。例如：“采购计划”的流程图存放成一个文件，“采购核算”的流程图存放成另一文件。其中“采购计划”、“采购核算”是两种具体业务。2．文件的开始内容，是所描述业务的名称。例如：“采购计划”流程图文件的第一页的题目是“采购计划”。3．在文件的Properties属性中，写明文件的“Title”、“Subject”、“Creator”及简单的描述“Description”。34．多页描述业务内容较多，不能在一页内完整描述时，分页描述。业务的起始内容书写在第一页，以后的内容放在后页中。5．页大小一般采用A4纸的大小，可以根据不同情况调整。三．书写格式流程图中所涉及的不同对象、不同的表达方式采用以下规定。1．业务名称。汉字书写，字号为14，黑体，居中或左对齐。2．各种对象的表示符号A．人员，例如操作员、记帐员、客户、供应商等，采用圆圈内书写人员的方式。B．判断，例如审核等，采用菱形符号，其判断结果为“Yes”或“No”，并且使用箭头指出。C．操作，例如记帐、材料出入库等，采用矩形符号，其中写明操作方式。一般来说，操作是由人员执行的，执行人在操作左边或上面表示，用箭头连接。D．输入操作，例如单据输入等，采用梯形符号，其中写明操作方式。制单人审核YesNo记帐记帐员记帐记帐制单人输入4E．实物，例如材料、产成品等，采用平行四边形符号，其中写明实物名称。F．单据，例如入库单、记帐凭证等，采用下面符号，其中写明单据名称。前者表示一张单据，后者表示多张单据。G．存档结果，采用下面符号，其中写明操作方式。3．表示符号的大小及字体规格各种表示符号不能忽大忽小，应在美观、流畅基础上设置，一般采用以下规格：圆圈大小直径为2cm，其他符号横向纵向比例为3：2，既横向为3cm，纵向为2cm。当然根据需要进行整体的适当放大。字体规格：字型为Arial,字号为10Pt.可随符号的放大，字体增大。4．表示符号的顺序及连接根据业务的流程，表示符号从左到右排列，之间采用箭头连接，并且箭头的两端分别连接符号的中间；对于分支的连接方式采用树状符号。例如：四．输出规定材料记帐凭证销售发票存档制单人录入凭证记帐存档帐薄记帐员审核No5在打印输出时，设置打印格式，预留装订线的位置。装订时，按照业务流程从上到下排列纸张顺序。第二节类图一．使用工具RationalRose二．操作步骤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．2rose的report（word文挡）第三节软件需求规格说明书该说明书应按照以下格式编写，具体如下：文档类别及使用对象1．导言1．1目的说明编写这份软件需求规格说明书的目的。１.2范围描述本文档所涉及的范围及未涉及的内容。1．3术语定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。1．4参考资料列出用得着的参考资料。61．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数据管理能力要求7说明需要管理的文卷和记录的个数、表和文卷的大小规模，要按可预见的增长对数据及其分量的存储要求作出估算。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．软件处理流程图8该流程图应是基于模块的。每个模块的流程图分主流程图和细化的流程图。细化的流程图的划分标准，以一个独立的业务对象或功能对象为依据。软件处理流程图的内容：功能处理流程的描述，主要处理方法的描述，主要系统参数的定义，与其他系统接口的描述。4．功能层次图是软件完成需求规格、处理流程的具体表现形式。功能层次应与业务流程相对应，以便于在精简或增加业务流程时，从功能层进行相应的减少或扩充。主要有以内容：功能层次图功能层次图以树状结构描述，功能层次图中，每一项功能都应规定字的功能号，这里的功能将是在软件实现时进行权限控制及作其它引用的功能号，因此在定义时必须遵循规定，这里规定功能号的格式如下：系统编号（两位）+功能层次号（4位）系统编号的规定参见附录；系统菜单定义出模块的下拉主菜单，各菜单中也要体现中功能号，以便于了解功能层次图同系统菜单各项的联系。5．详细设计详细设计应基于功能层次图及以前各部分资料，其主要内容包括界面设计、程序处理流程、方法、说明等等，是程序员进行程序设计的依据。具体内容如下：——任务编号／名称：作为某一任务的标识。——背景描述：对这一任务的背景进行简单的描述。——涉及数据表（主要／相关）：该任务涉及到的主要操作表及相关操作表。——界面：该任务所用到的所有界面的描述。界面中所涉及到的项目的解释。——功能、性能：该任务要提供的功能及其描述，以及应达到的性能要求。——处理：该任务的处理流程。对于简单任务，可不进行描述。——主要算法设计：该任务所涉及到的主要算法及描述，对于简单或常用的算法可不必进行描述。——注意事项：对于一些特别需求注意的事项要在此注明。6．数据结构设计包括以下内容：——表名／识别名称：任为表的标识。——属性描述：描述该表的所有属性及各属性的属性，主外键描述等，具体格式如下：表名表的命名，命名规范识别名称表示意议的汉字名称索引如有多个索引，分别列出序号名称识别名类型空否缺省检查主／外键备注主键用ＰＫ表示，外键用ＦＫ表示，如果为外键，则要在备注中指明引用的表。该项内容也可以直接从类图生成的资料成获得，按原格式即可。9——索引描述：描述该表的索引，将所有的索引都列示出来，具体格式：索引：名称［，unique］[,clustered],列名——涉及方法：该表所涉及的操作。第三章软件实现规范第一节组织方式产品的结构应遵守的原则：执行方便、登录简单、相互联系、风格流行。执行方便是指在用户在操作时能够很方便的操作国强财务软件能中的任何一个模块；登录简单是指用户在登录国强财务软件时是不需录经过太复杂的过程，能够很直接的进行系统进行操作；相互联系是指用户登录进行某一个子系统后，不需要再重新登录就能直接转换到其它子系统下进行操作；风格流行是指产品的形式、结构要符合当前流行软件及同类产品中一些优秀软件的形式和结构。签于以上原则，建议国强财务软件的组织方式如下：国强财务软件按照子系统进行划分，每一个子系统作为一个应用软件，建立一个独立的图标，建立国强财务软件组，各子系统的图标均在该组内。各个子系统的应用菜单中，应均有一项联接其它子系统的菜单。各个子系统的登录方式如下：执行程序时首先显示一欢迎窗口，该窗口应以简炼、精致、准确反映信息为原则；显示完迎窗口后显示登录窗口，在该窗口中应允许输入登录编号、登录口令、选择帐套，可以新建帐套、新建用户；登录信息输入正确后进行该套帐进行操作。具体如下图：各子系统的操作主画面还是以传统的下拉式菜单加TOOLBAR的方式，第一行为主操作菜单，第二行为TOOLBAR，最后一行为运行状态。对于各个具