软件设计说明书编写规范_副本.docVIP

PAGE9 / NUMPAGES10软件设计说明书编写规范目录 TOC \o 1-3 \h \z \u HYPERLINK \l _Toc183158771 软件设计说明书编写规范 PAGEREF _Toc183158771 \h 2 HYPERLINK \l _Toc183158772 一、 编写目的 PAGEREF _Toc183158772 \h 2 HYPERLINK \l _Toc183158773 二、 应用文档 PAGEREF _Toc183158773 \h 2 HYPERLINK \l _Toc183158774 三、 要求及内容 PAGEREF _Toc183158774 \h 2 HYPERLINK \l _Toc183158777 2.1 编写格式要求 PAGEREF _Toc183158777 \h 2 HYPERLINK \l _Toc183158778 2.2 说明书内容 PAGEREF _Toc183158778 \h 2 HYPERLINK \l _Toc183158779 2.2.1 说明书目的 PAGEREF _Toc183158779 \h 2 HYPERLINK \l _Toc183158780 2.2.2 参考资料及文档 PAGEREF _Toc183158780 \h 3 HYPERLINK \l _Toc183158781 2.2.3 设计原则 PAGEREF _Toc183158781 \h 3 HYPERLINK \l _Toc183158782 2.2.4 接口描述 PAGEREF _Toc183158782 \h 4 HYPERLINK \l _Toc183158783 2.2.5 功能描述 PAGEREF _Toc183158783 \h 5 HYPERLINK \l _Toc183158784 2.2.6 接口协议 PAGEREF _Toc183158784 \h 5 HYPERLINK \l _Toc183158785 2.2.7 编程协定 PAGEREF _Toc183158785 \h 5 HYPERLINK \l _Toc183158786 2.2.8 数据结构 PAGEREF _Toc183158786 \h 6 HYPERLINK \l _Toc183158787 2.2.9 逻辑结构 PAGEREF _Toc183158787 \h 6 HYPERLINK \l _Toc183158788 2.2.10 程序流程 PAGEREF _Toc183158788 \h 6 HYPERLINK \l _Toc183158789 2.2.11 源文件列表 PAGEREF _Toc183158789 \h 8 HYPERLINK \l _Toc183158790 2.2.12 其他 PAGEREF _Toc183158790 \h 9 HYPERLINK \l _Toc183158791 2.3 文档修订历史 PAGEREF _Toc183158791 \h 9 HYPERLINK \l _Toc183158792 四、 编写文档注意事项 PAGEREF _Toc183158792 \h 9 HYPERLINK \l _Toc183158793 五、 样例及模板文档 PAGEREF _Toc183158793 \h 9编写目的项目主管或软件工程师根据《软件需求说明书》，对程序系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计。?运行设计、数据结构设计和出错处理设计等，需编写《软件设计说明书》，本文档供项目主管和软件工程师遵循《用户需求规格说明书》（见《用户需求规格说明书编写规范》）如何编写《软件设计说明书》所编写的规范。应用文档本文在编写时所应用到下列文件：《文档编排格式规范》《软件需求规格说明书》《UML时序图规范说明书》要求及内容编写格式要求在编写《软件设计说明书》时，对封面、正文、字体及编号应参考《文档编排格式规范》约定的格式对封面、正文、字体、大纲及编号进行编写。说明书内容说明书目的软件设计说明书又可称系统设计或程序设计，这里所说的系统是指程序系统。编制的目的是说明对程序?系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计。?运行设计、数据结构设计和出错处理设计等；更详细设计说明是将一个软件系统各个层次中的每一个程序?（每个模块或子程序）的设计考虑，此时可对程序较为详细设计，如果一个软件系统比较简单，层次很少，可直接编写系统设计，本说明书可供软件设计师、项目主管及测试人员使用。参考资料及文档列出编写本说明书时参考的文件(如经核准的