软件设计说明书编写规范.doc

软件设计说明书编写规范.doc

ID:61430189

大小:63.00 KB

页数:9页

时间:2021-01-29

软件设计说明书编写规范.doc_第1页
软件设计说明书编写规范.doc_第2页
软件设计说明书编写规范.doc_第3页
软件设计说明书编写规范.doc_第4页
软件设计说明书编写规范.doc_第5页
资源描述:

《软件设计说明书编写规范.doc》由会员上传分享,免费在线阅读,更多相关内容在应用文档-天天文库

1、软件设计说明书编写规范目录软件设计说明书编写规范2一、编写目的2二、应用文档2三、要求及内容22.1编写格式要求22.2说明书内容22.2.1说明书目的22.2.2参考资料及文档32.2.3设计原则32.2.4接口描述42.2.5功能描述52.2.6接口协议52.2.7编程协定52.2.8数据结构62.2.9逻辑结构62.2.10程序流程62.2.11源文件列表82.2.12其他92.3文档修订历史9四、编写文档注意事项9五、样例及模板文档9一、编写目的项目主管或软件工程师根据《软件需求说明书》,对程序系统的设计考虑,包括程序系统的基本处理流程、

2、程序系统的组织结构、模块划分、功能分配、接口设计。 运行设计、数据结构设计和出错处理设计等,需编写《软件设计说明书》,本文档供项目主管和软件工程师遵循《用户需求规格说明书》(见《用户需求规格说明书编写规范》)如何编写《软件设计说明书》所编写的规范。二、应用文档本文在编写时所应用到下列文件:Ø《文档编排格式规范》Ø《软件需求规格说明书》Ø《UML时序图规范说明书》三、要求及内容122.1编写格式要求在编写《软件设计说明书》时,对封面、正文、字体及编号应参考《文档编排格式规范》约定的格式对封面、正文、字体、大纲及编号进行编写。2.2说明书内容2.2.

3、1说明书目的软件设计说明书又可称系统设计或程序设计,这里所说的系统是指程序系统。编制的目的是说明对程序 系统的设计考虑,包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计。 运行设计、数据结构设计和出错处理设计等;更详细设计说明是将一个软件系统各个层次中的每一个程序 (每个模块或子程序)的设计考虑,此时可对程序较为详细设计,如果一个软件系统比较简单,层次很少,可直接编写系统设计,本说明书可供软件设计师、项目主管及测试人员使用。2.2.2参考资料及文档列出编写本说明书时参考的文件(如经核准的计划任务书或合同、上级机关的批文

4、等)、资料、技术标准,以及他们的作者、标题、编号、发布日期和出版单位等。1.1.1设计原则1.1.1.1界面设计原则设计大体遵循以下原则:A.界面简洁大方B.附有详细的说明C.遵循用户的操作习惯D.具有指引性E.色调协调1.1.1.2数据结构设计原则设计大体遵循以下原则:A.每个数据表都设有主键,做为流水号,放在第一字段;字段名使用中文字段命名。B.字段类型使用字符型,整形,浮点型,时间型及二进制型。C.只使用数据库的存储功能,数据表间的关系以程序逻辑实现控制。1.1.1.3程序结构设计原则程序结构设计,对软件程序做出一个划分,应根据具体情况不同

5、,做出不同的调整,程序结构设计过程中,经常用到的程序结构划分方式包括:A.根据功能划分B.根据技术划分C.根据程序借口划分D.程序结构划分应大体遵循以下原则:1)应以用户为中心划分2)围绕中心问题划分3)符合结构清晰,层次简明的原则1.1.1.1框图、UML协作图和UML时序图程序需包含系统结构框图,较为复杂时应提供相应的UML协作图(见《UML时序图规范说明书》)。在涉及到复杂方法体时应引用程序员为方法或过程编写的UML时序图。1.1.2接口描述1.1.2.1软件模块分配A.数据处理软件模块;数据处理软件模块是整个软件的基础,为整个软件提供分析

6、数据,其接口要求如下表:[此处加入接口要求表]B.数据分析软件模块;分析软件模块包括电能、电压、电量、谐波4个模块,是整个软件的功能实现,实现软件的分析功能,其接口要求分别如表1,表2,表3,表4及表5:[此处加入表]说明:表5是xxxxxx.C.报表软件模块;报表软件模块是为整用户提供报表功能,其接口要求如下表:[此处加入接口要求表]D.主界面软件模块;主界面软件模块是整个软件的总控,为软件的各个模块提供接口,其接口要求如下表:[此处加入接口要求表]由于上表较长,表中分为3部分,表中第2部分说明为:xxxxxxxxxxxxx1.1.2.2模块之

7、间的关系[此处加入模块之间的关系]1.1.3功能描述A.功能说明[此处加入功能说明]A.功能框图[此处加入功能框图]B.时顺图复杂功能可用UML时序图(见《UML时序图规范说明书》)表示。1.1.1接口协议[此处加入接口协议]1.1.2编程协定A.操作系统windowsNT操作系统,或windows98操作系统.B.编程工具Delphi7.0编程工具,由于该软件工具具有可视化编程,对象化处理的优点,利于我们快速完成编程工作,减少编程BUG,提高工作效率,降低开发成本;因此,我们确定使用该软件为软件的主界面,分析,及报表功能的开发平台。VC++编程

8、工具,由于该软件具有编程深度高,实现灵活,有利于完成我们软件中的入库程序。另外,根据本软件的特点:xxxxxxxxxxxxxC.编辑、调

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。