《软件设计说明书编写规范》由会员分享，可在线阅读，更多相关《软件设计说明书编写规范（9页珍藏版）》请在金锄头文库上搜索。
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.1 说明书目的软件设计说明书又可称系统设计或程序设计，这里所说的系统是指程序系统。编制的目的是说明对程序系统的设计考虑，包括程序
3、系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计。运行设计、数据结构设计和出错处理设计等；更详细设计说明是将一个软件系统各个层次中的每一个程序（每个模块或子程序）的设计考虑，此时可对程序较为详细设计，如果一个软件系统比较简单，层次很少，可直接编写系统设计，本说明书可供软件设计师、项目主管及测试人员使用。2.2.2 参考资料及文档列出编写本说明书时参考的文件(如经核准的计划任务书或合同、上级机关的批文等)、资料、技术标准，以及他们的作者、标题、编号、发布日期和出版单位等。2.2.3 设计原则2.2.3.1 界面设计原则设计大体遵循以下原则：A. 界面简洁大方B. 附有详细的说
4、明C. 遵循用户的操作习惯D. 具有指引性E. 色调协调2.2.3.2 数据结构设计原则设计大体遵循以下原则：A. 每个数据表都设有主键，做为流水号，放在第一字段；字段名使用中文字段命名。B. 字段类型使用字符型，整形，浮点型，时间型及二进制型。C. 只使用数据库的存储功能，数据表间的关系以程序逻辑实现控制。2.2.3.3 程序结构设计原则程序结构设计，对软件程序做出一个划分，应根据具体情况不同，做出不同的调整，程序结构设计过程中，经常用到的程序结构划分方式包括：A. 根据功能划分B. 根据技术划分C. 根据程序借口划分D. 程序结构划分应大体遵循以下原则：1) 应以用户为中心划分2) 围绕中
5、心问题划分3) 符合结构清晰，层次简明的原则2.2.3.4 框图、UML协作图和UML时序图程序需包含系统结构框图，较为复杂时应提供相应的UML协作图（见UML时序图规范说明书）。在涉及到复杂方法体时应引用程序员为方法或过程编写的UML时序图。2.2.4 接口描述2.2.4.1 软件模块分配A. 数据处理软件模块；数据处理软件模块是整个软件的基础，为整个软件提供分析数据，其接口要求如下表：此处加入接口要求表B. 数据分析软件模块；分析软件模块包括电能、电压、电量、谐波 4个模块，是整个软件的功能实现，实现软件的分析功能，其接口要求分别如表1，表2，表3，表4及表5：此处加入表说明：表5 是xx
6、xxxx.C. 报表软件模块；报表软件模块是为整用户提供报表功能，其接口要求如下表：此处加入接口要求表D. 主界面软件模块；主界面软件模块是整个软件的总控，为软件的各个模块提供接口，其接口要求如下表：此处加入接口要求表由于上表较长，表中分为3部分，表中第2部分说明为：xxxxxxxxxxxxx2.2.4.2 模块之间的关系此处加入模块之间的关系2.2.5 功能描述A. 功能说明此处加入功能说明B. 功能框图此处加入功能框图C. 时顺图复杂功能可用UML时序图（见UML时序图规范说明书）表示。2.2.6 接口协议此处加入接口协议2.2.7 编程协定A. 操作系统windows NT 操作系统，或
7、windows 98 操作系统.B. 编程工具Delphi 7.0 编程工具，由于该软件工具具有可视化编程，对象化处理的优点，利于我们快速完成编程工作，减少编程BUG ，提高工作效率，降低开发成本；因此，我们确定使用该软件为软件的主界面，分析，及报表功能的开发平台。VC+ 编程工具，由于该软件具有编程深度高，实现灵活，有利于完成我们软件中的入库程序。另外，根据本软件的特点：xxxxxxxxxxxxxC. 编辑、调试、联接程序此处加入编辑、调试、联接程序D. 编译工具此处加入编译工具E. 模拟、仿真数据模拟数据使用过去的真实数据，数据如下：此处加入数据过程、方法如下：此处加入过程、方法F. 诊断
8、、测试程序此处加入诊断、测试程序G. 检测程序此处加入检测程序2.2.8 数据结构A. 物理结构此处加入物理结构B. 库结构此处加入库结构C. 链路结构此处加入链路结构D. 表结构此处加入表结构E. 内部存贮区分配此处加入内部存贮区分配2.2.9 逻辑结构A. 常量定义此处加入常量定义B. 变量定义此处加入变量定义C. 结构定义此处加入结构定义D. 全局定义此处加入全局定义2.2.10 程序流程A. 主程序1) 功能此处加入功能2) 入口参数此处加入入口参数3) 出口参数此处加入出口参数4) 局部变量此处加入局部变量5) 函数调用此处加入函数调用6) 对象调用此处加入对象调用7) 流程图此处加
9、入流程图8) UML时序图（见UML时序图规范说明书）仅用于复杂程序流程，一般可用流程图表示即可。B. 子程序1) 功能此处加入功能2) 入口参数此处加入入口参数3) 出口参数此处加入出口参数4) 局部变量此处加入局部变量5) 函数调用此处加入函数调用6) 流程图此处加入流程图7) UML时序图或协作图（见UML时序图规范说明书）仅用于复杂程序流程，一般可用流程图表示即可。C. 信息及通讯1) 信息类型此处加入信息类型2) 信息等级此处加入信息等级3) 功能此处加入功能4) 入口参数此处加入入口参数5) 出口参数此处加入出口参数6) 局部变量此处加入局部变量7) 队列此处加入队列8) 流程图此处加入流程图D. 对象1) 功能此处加入功能2) 入口参数此处加入入口参数3) 出口参数此处加入出口参数4) 变量（私有，公有，重载等）此处加入变量5) 函数此处加入函数6) 属性此处加入属性7) 流程图此处加入流程图2.2.11 源文件列表此处加入源文件列表列表如下：序号应用程序文件名作用存放路径2.2.12 其他相关参考资料及文档其他信息2.3 文档修订历史文档修订列表如下：修定版本更改人日期描述（注明修改的条款或页）批准人签字如下修定版本职务姓名日期四、 编写文档注意事项五、 样例及模板文档样板请参考软件设计说明书模板文档。 下载 9 / 9
