软件概要设计说明
#+DATA:<2021-01-17 日>
#+KEYDORDS:软件设计、概要设计
::: {.center} xx公司
2020-01-01 :::
文档管理
合理地管理主文档, 确保文档版本的及时更新,同时保持备份文档和源文档的一致性。
版本管理
本版本修订日期 2019-08-12 生效日期 2019-08-12
版本 生效日期 变更内容 编制人
V1.0 2020-01-01 初稿编写完成 xx
引言
编写目的
说明编写这份概要设计说明书的目的,指出预期的读者。(对于由多个子系统构成的系统,可以根据需要针对子系统编写单独的软件概要设计说明)
背景
说明:
待开发软件系统的名称;
列出此项目的任务提出者、开发者、用户以及将运行该软件的位置;
术语和缩略语
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
参考资料
列出有关的参考文件,如:
本项目的经核准的计划任务书或合同,上级机关的批文;
属于本项目的其他已编制文件;
本文件中各处引用的文件、资料,包括所要用到的软件开发标准、专业技术标准。列出这些文件的标题、文件编号、发表日期、出版单位和来源。
总体设计
需求规定
说明对本系统的主要的输入输出项目、处理的功能性能要求。可以引用软件规格说明文档以避免重复。
运行环境
简要地说明对本系统的运行环境(包括硬件环境和支持环境)的规定。
设计思想
系统构思
说明本系统设计的系统构思。
关键技术与算法
说明本系统设计采用的关键技术和主要算法。
关键数据结构
简要说明本系统实现中的最主要的数据结构。
系统总体结构
以图表的形式说明本系统的系统元素(各层模块、子模块、公用模块等)的划分,扼要说明各系统元素的标识和功能,分层次说明各系统元素之间的关系。
基本处理流程
系统流程图
用流程图的方式说明本系统的主要控制流程和处理流程。
数据流程图
根据需要,用数据流程图说明本系统的主要数据及其流转过程,并说明流转过程中的处理动作。
功能需求与模块的关系
说明各项功能需求的实现同各模块的分配关系。要与软件规格说明中的功能编号相一致。
尚未解决的问题
说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。
接口设计
外部接口
说明本系统同外界的所有接口设计。包括本系统与硬件之间的接口设计、本系统与各支持软件之间的接口设计、对外提供的接口服务的设计。
内部接口
说明本系统之内的各个系统元素之间的接口的安排。
性能设计及质量属性考虑
通过设计落实在软件规格说明中的各种性能及质量属性规定。
数据库设计
说明本系统内所使用的数据结构设计要点及与程序模块间的关系。对数据库表的设计一般以另文方式(数据库设计说明)给出。
内容审核要点:
是否全面考虑了软件需求规格说明文档的功能需求; 所述功能名称及编号与软件需求规格说明文档是否一致; 总体结构是否清晰合理; 是否包括对外提供的接口服务的形式化表述和设计内容; 数据结构设计内容的全面性及合理性;
参考