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

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