软件设计报告模板(适用于各种开发语言)

传统的分析设计过程,分为《概要设计说明书》和《详细设计说明书》。系统设计报告对应概要设计。系统设计报告1引言1.1编写目的说明编写本《系统设计报告》的目的。1.2背景说明理解本报告所需的背景，如与公司其它软件之间的联系等。1.3参考资料列出编写本报告时参考的文件(如经核准的计划任务书或合同、上级领导的批文等)、资料、技术标准，以及他们的作者、标题、编号、发布日期和出版单位。列出编写本报告时查阅的Internet上杂志、专业著作、技术标准以及他们的网址。1.4术语列出本系统设计说明书中专门术语的定义和英文缩写词的原词组。2总体设计2.1系统运行环境给出本软件系统运行所需的基本软/硬件环境、使用本软件系统典型用户的设备分布图及设备上相应软件配置。软件环境包括：操作系统、数据库、以及其它支撑软件；硬件环境包括：主机类型、网络类型、存储器容量、其它特殊设备。2.2系统设计模型使用建模工具给出可视化的系统描述，建议使用RationalRose等工具。2.3软件功能描述描述被开发软件的功能，如有同等作用的文件（如已编写的《软件功能规格说明书》）则可直接在此引述该文件名及归档的部门即可。2.4软件结构以图表形式给出软件子系统结构和模块组成结构。凡单独编写《系统设计报告》的子系统，其内部自用的模块不必列出。2.5技术路线给出本软件系统在实现过程中所采用的技术路线、方法。对比较新的技术给予详细的阐述及必要的说明，在可能的情况下给出相应的技术参考资料。2.6外部接口2.6.1用户接口描述该软件与用户的接口，包括用户输入输出界面样式、操作方式和界面间的转移关系。如具有等同作用的文件（如使用开发工具编写的界面原型程序等），本处仅需列出该文件名、保管部门即可。2.6.2软件接口描述该软件与其它系统的软件接口，主要说明其它系统提供的编程接口和本系统向其它系统提供的编程接口，如具有等同作用的文件（如包含接口说明及注释的源文件程序头文件、接口帮助的超文本文件等），本处仅需列出该文件名、保管部门即可。2.6.3其它接口描述该软件与其它系统的其它类型接口，主要说明其它系统提供的和本系统向其它系统提供的硬件接口、通信协议及规程、数据交换格式等，如具有等同作用的文件，本处仅需列出该文件名、保管部门即可。3模块设计3.1功能3.1.1简述各模块的功能。3.2性能3.2.1说明对各模块的性能要求，包括精度、时间特性和处理速度。3.3内部接口3.3.1说明各模块之间接口，包括：3.3.1.1各模块的用途、使用(调用)方式；3.3.1.2说明其每个子程序（方法，Method）、特性（Property）和反馈的事件（Event），相应的输入、输出项说明；3.3.1.3指明各模块内含的各类外部接口，并列出这些外部接口说明材料名。3.4外部存贮结构设计说明本系统存贮于磁盘等持久性存贮介质，而且不是由数据库管理系统进行管理的数据的组织结构，包括数据名称、用途、每个数据项的标识名、类型和含义，组织结构、访问方法和存储要求。4数据库设计4.1数据库模型此处需要给出数据库设计模型，建议使用PowerDesigner等工具。4.2数据字典设计对数据库设计中涉及到的各种项目，如数据项、记录、表、数据库等建立数据字典，以说明它们的标识符、同义名及有关信息，并说明对此数据字典设计的基本考虑。凡采用数据库设计工具生成的数据字典，本处仅需列出对应的文件名、保管部门即可。4.3安全保密设计说明在数据库的设计中，如何通过区分不同的访问者、不同的访问类型和不同的数据对象，进行分别对待而获得的数据库安全保密设计考虑。5测试设计5.1测试用例5.1.1详细描述测试用例类型，重点是白盒测试和黑盒测试。5.2预期结果5.2.1描述每个测试预期的结果6系统安全6.1系统安全6.1.1系统安全控制和物理保护措施6.1.2用户身份鉴别6.1.3用户对系统的访问权限和范围6.2数据安全6.2.1数据用户身份鉴别6.2.2访问主体、访问对象的控制策略和实现方法6.2.3数据加密方法6.3备份与恢复6.3.1系统备份6.3.2数据备份6.3.3系统恢复6.3.4数据恢复6_4出错处理6_4.1列举出错情况6_4.2出错的形式、含义、处理方法6_4.3出错失效后的后备措施另外可以分为《体系结构设计报告》、《用户界面设计报告》、《数据库设计报告》、《模块设计报告》-(林锐)。系统设计报告大概对应体系结构设计报告。1文档介绍1.1文档目的1.2文档范围1.3读者对象1.4参考文献提示：列出本文档的所有参考文献（可以是非正式出版物），格式如下：[标识符]作者，文献名称，出版单位（或归属单位），日期例如：[AAA]作者，《立项建议书》，机构名称，日期[SPP-PROC-SD]SEPG，系统设计规范，机构名称，日期1.5术语与缩写解释缩写、术语解释SPP精简并行过程，SimplifiedParallelProcessSD系统设计，SystemDesign…2.系统概述提示：（1）说明本系统“是什么”，（2）描述本系统的主要功能。3.设计约束提示：（1）需求约束。体系结构设计人员从需求文档（如《用户需求说明书》和《软件需求规格说明书》）中提取需求约束，例如：本系统应当遵循的标准或规范软件、硬件环境（包括运行环境和开发环境）的约束接口/协议的约束用户界面的约束软件质量的约束，如正确性、健壮性、可靠性、效率（性能）、易用性、清晰性、安全性、可扩展性、兼容性、可移植性等等。（2）隐含约束。有一些假设或依赖并没有在需求文档中明确指出，但可能会对系统设计产生影响，设计人员应当尽可能地在此处说明。例如对用户教育程度、计算机技能的一些假设或依赖，对支撑本系统的软件硬件的假设或依赖等。4.设计策略提示：体系结构设计人员根据产品的需求与发展战略，确定设计策略（DesignStrategy）。例如：扩展策略。说明为了方便本系统在将来扩展功能，现在有什么措施。复用策略。说明本系统在当前以及将来的复用策略。折衷策略。说明当两个目标难以同时优化时如何折衷，例如“时－空”效率折衷，复杂性与实用性折衷。5.系统总体结构提示：（1）将系统分解为若干子系统，绘制物理图和逻辑图，说明各子系统的主要功能。（2）说明“如何”以及“为什么”（howandwhy）如此分解系统。（3）说明各子系统如何协调工作，从而实现原系统的功能。6.子系统N的结构与功能提示：（1）将子系统N分解为模块（Module），绘制逻辑图（如果物理图和逻辑图不一样的话，应当绘制物理图），说明各模块的主要功能。（2）说明“如何”以及“为什么”（howandwhy）如此分解子系统N。（3）说明各模块如何协调工作，从而实现子系统N的功能。7.开发环境的配置提示：说明本系统应当在什么样的环境下开发，有什么强制要求和建议？类别标准配置最低配置计算机硬件软件网络通信其它8.运行环境的配置提示：说明本系统应当在什么样的环境下运行，有什么强制要求和建议？类别标准配置最低配置计算机硬件软件网络通信其它9.测试环境的配置提示：说明本系统应当在什么样的环境下测试，有什么强制要求和建议？（1）一般地，单元测试、集成测试环境与开发环境相同。（2）一般地，系统测试、验收测试环境与运行环境相同或相似（更加严格）。10.其它