软件系统设计报告编写规范

相关的软件和硬件
操作系统
最终用户特征
在功能上可能发生的变化
3.2General Constraints一般限制
描述对软件系统的设计有重要影响的全局限制或约束。
硬件或软件环境；
最终用户环境；
资源的可用性和挥发性；
标准的兼容；(option)
协同工作的要求；
接口/协议的要求；
数据储存和发布要求；
安全性的要求（或其它类似的规则）；
4.
4.1
1）整个规范由2节构成，模板单独一节。
2）正文样式采用“规范正文”。
3）标题编号采用每节独立编号。
4.2
系统设计报告的编写可依据具体情况选用摸板的格式或编写指南的格式。
1）拷贝规范。
2）删除第一节（系统设计报告封面前的所有页）。
3）在修改完内容后，更新目录域和相关的页数域。
5.
(无)
6.
以下部分为系统设计报告的模板与编写指南。
1.4
列出编写参考的文件、资料、技术标准以及他们的作者、标题、编号、发布日期和出版单位。
编号
资料名称
简介
作者
日期
出版单位
列出编写本报告时需查阅的Intenet上杂志、专业著作、技术标准以及他们的网址。
网点
简介
7.
7.1
给出本软件系统运行所需的基本软/硬件环境、使用本软件系统典型用户的设备分布图及设备上相应软件配置。软件环境包括：操作系统、数据库、以及其它支撑软件；硬件环境包括：主机类型、网络类型、存储器容量、其它特殊设备。
7.2
描述被开发软件的功能，如有同等作用的文件（如已编写的《软件功能规格说明书》）则可直接在此引述该文件名及归档的部门即可。
7.3
以图表形式给出软件子系统结构和模块组成结构。凡单独编写《系统设计报告》的子系统，其内部自用的模块不必列出。
7.4
给出本软件系统在实现过程中所采用的技术路线、方法。对比较新的技术给予详细的阐述及必要的说明，在可能的情况下给出相应的技术参考资料。
1)各模块的用途、使用(调用)方式；
2)说明其每个子程序（方法，Method）、特性（Property）和反馈的事件（Event），相应的输入、输出项说明；
3)指明各模块内含的各类外部接口，并列出这些外部接口说明材料名。
8.4
说明本系统存贮于磁盘等持久性存贮介质，而且不是由数据库管理系统进行管理的数据的组织结构，包括数据名称、用途、每个数据项的标识名、类型和含义，组织结构、访问方法和存储要求。
7.5.3
描述该软件与其它系统的其它类型接口，主要说明其它系统提供的和本系统向其它系统提供的硬件接口、通信协议及规程、数据交换格式等，如具有等同作用的文件，本处仅需列出该文件名、保管部门即可。
8.
8.1
简述各模块的功能。
8.2
说明对各模块的性能要求，包括精度、时间特性和处理速度。
8.3
说明各模块之间接口，包括：
10.2
说明在数据库的设计中，如何通过区分不同的访问者、不同的访问类型和不同的数据对象，进行分别对待而获得的数据库安全保密设计考虑。
系统设计报告编写指南之一
1.Introduction介绍
描述这个文档的编写目的；
描述这个文档的适用范围；
描述这个文档的读者；
确定这个系统/产品的名称和/或版本号；
定义重要的术语、缩写词或缩略语；
9.
说明本系统所采用的基本错误处理方法和原则，例如：统一采用C++ try-catch错误方法，所有错误最终必须以界面形式向用户说明。用一览表方式说明各类可能的错误或故障出现时系统的处理方法和据库设计中涉及到的各种项目，如数据项、记录、表、数据库等建立数据字典，以说明它们的标识符、同义名及有关信息，并说明对此数据字典设计的基本考虑。凡采用数据库设计工具（如ER图设计工具）生成的数据字典，本处仅需列出对应的文件名、保管部门即可。
内存和其它的容量限制；
性能要求；
网络通信；(option)
验证和确认的要求（测试）；
其他质量目标的要求；
在需求分析说明书中所描述的其它要求。
3.3Goals and Guidelines目标和指导方针
描述所有支配软件系统设计的目标、指导方针、原则或者优先权。
7.5
7.5.1
描述该软件与用户的接口，包括用户输入输出界面样式、操作方式和界面间的转移关系。如具有等同作用的文件（如使用开发工具编写的界面原型程序等），本处仅需列出该文件名、保管部门即可。
7.5.2
描述该软件与其它系统的软件接口，主要说明其它系统提供的编程接口和本系统向其它系统提供的编程接口，如具有等同作用的文件（如包含接口说明及注释的源文件程序头文件、接口帮助的超文本文件等），本处仅需列出该文件名、保管部门即可。
密级：
文档编号：第版
分册名称：第册/共册
项目名称（项目编号）
系统设计报告
（部门名称）
总页数
正文
附录
生效日期：年月日
编制：
审核：
批准：
1.
1.1
说明编写本《系统设计说明书》的目的。
1.2
说明理解本报告所需的背景，如与公司其它软件之间的联系等。
1.3
列出本系统设计说明书中专门术语的定义和英文缩写词的原词组。
系统设计报告编写规范
文件编号：
生效日期：
受控编号：
密级：
版次：Ver2.1
修改状态：
总页数
19
正文
4
附录
15
编制：
审核：
批准：
文件修改控制
修改记录编号
修改
状态
修改页码及条款
修改人
审核人
批准人
修改日期
1.目的
2.适用范围
3.术语及缩略语
4.编写规范
4.1排版规范
4.2模板使用
5.引用文件
6.附录
1.
系统设计报告主要为使软件产品和软件项目满足规定的软件规格要求而确定软件系统的体系结构、组成成分、数据组织、模块、内外部接口。主要任务有：
总结（或给出一个概要）这个文档的内容。
2.System Overview系统概述
对软件系统的一般性描述，包括系统的功能和其他与设计相关的内容。
3.Design Considerations设计上的考虑
本节描述在完成一个完整的设计解决方案之前必须阐明或解决的问题。
3.1Assumptions and Dependencies假设和依赖
1)建立软件产品和软件项目目标系统的总体结构。对于大规模软件系统，应分为若干子系统，在本报告中只说明总体设计，然后为每个子系统编写《系统设计报告》；
2)总体设计；
3)模块设计；
4)涉及使用数据库的设计需编写数据库设计。
2.
适用于软件开发设计阶段的《系统设计报告》的编写。
3.
本程序采用NQ402100《质量手册》中的术语和缩略语及其定义。