软件设计说明书_XXX子系统(分层级的)_V1.0
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
软件设计说明书
产品发布标识_XXX子系统
[填写说明:模板中用方括号括起来并以蓝色斜体显示的文本,用于向作者提供指导,在文档编辑完成后应该将其删除。文档正文应使用常规、黑色、五号字体即系统设置的“正文”样式]
文档页眉处的“xxxx系统”和“版本号”仅为示例,请注意更新封页与页眉符合实际情况。此处的版本号指的是产品版本号。封页简要表中的产品名和子系统名,如无可以不填写。
当某一章节如没有内容时,必须注明NA,同时标注理由。例如:本节内容无需考虑
特别说明:当本节内容参见其它文档内容,不能注明N/A,而应该写明参见某文档的具体章节。]
[特殊说明:产品对应的相关系统以及逻辑和物理结构划分参照下图]
郑州……公司版权所有
内部资料注意保密
修订记录:
目录
1 简介 (1)
1.1 目的 (1)
1.2 文档范围 (1)
1.3 预期的读者和阅读建议 (1)
1.4 参考文档 (1)
1.4.1 包含文档 (2)
1.4.2 相关文档 (2)
1.5 缩略语和术语 (2)
2 设计原则 (2)
3 设计策略 (2)
4 第零层设计描述 (3)
4.1 概述 (3)
4.2 设计约束 (3)
4.2.1 遵循标准 (3)
4.2.2 硬件限制 (3)
4.2.3 技术限制 (3)
4.2.4 其它 (3)
5 第一层设计描述 (4)
5.1 模块分解描述 (4)
5.1.1 模块功能列表 (4)
5.1.2 模块间交互图 (4)
5.1.3 模块重用设计 (4)
5.1.3.1 以往设计的重用 (6)
5.1.3.2 可重用性考虑 (6)
5.2 数据分解 (6)
5.3 接口描述 (6)
5.4 数据库设计 (7)
5.4.1 实体、属性及它们之间的关系 (7)
5.4.2 实体关系图 (7)
5.5 安全性设计 (7)
6 第二层设计 (8)
6.1 MOD(编号):模块一 (8)
6.1.1 简介 (8)
6.1.2 方法 (8)
6.1.2.1 方法列表 (8)
6.1.2.2 方法1 (8)
6.1.2.3 方法n (9)
6.1.3 实现方式 (9)
6.1.4 限制条件 (9)
6.1.5 生命周期 (9)
6.1.6 第三方引用 (10)
6.2 MOD(编号):模块二 (10)
7 系统容错处理设计 (10)
7.1 可能出错信息 (10)
7.2 补救措施 (10)
8 系统可维护性设计 (10)
9 假设前提 (10)
10 风险 (11)
11 附录 (11)
1 简介
1.1 目的
[描述本设计文档的主要目的。
一般情况下,概要设计的目的是根据产品需求、软件需求文档中对需求的描述,结合架构设计文档中对方案的描述,对具体实现方案进行细化,精确到各模块的功能、实现及其模块之间的交互,指导后续的底层设计、编码、单元测试工作,并对测试工作起到辅助、参考作用。
其他情况请另外说明。]
1.2 文档范围
[简要说明此文档的范围:它的相关项目以及受到此文档影响的任何其它事物。
例如,本文档适用的产品、模块,覆盖的范围等,受这份文档影响的相关产品、模块等,不在该文档覆盖范围内的但可能引起疑义的问题。]
1.3 预期的读者和阅读建议
[说明此文档的阅读对象,对读者的要求;简要说明此文档中其它章节包含的内容与文档组织方式,对于不同读者的阅读方式建议。
如:
目标读者是系统最终用户、系统分析员、项目经理、产品经理、市场人员等。]
1.4 参考文档
[适当时,提供相关的包含文档及参考文档。
概要设计说明书的参考文档应当包括但不限于:产品需求说明书,软件需求说明书,架构设计说明书,数据库设计说明书,设计规范等;
同时,文档中说明为引用、参考的文档也应该在这里列出。
参考文档请按包含、相关的关系分别在下面列出。]
1.4.1 包含文档
[包含文档:作为本概要设计的一部分,不可分割的组成部分,读者阅读本设计说明书时必须同时也阅读的文档。如数据库设计说明书(如果数据库设计有变更)。
通常情况下概要设计文档没有包含文档]
1.4.2 相关文档
[相关文档:作为引用而列举的文档。读者在阅读本设计说明书时如果有必要可以参考阅读的文档。如产品需求说明书、设计规范文档等]
1.5 缩略语和术语
[适当时,提供与此文档相关的术语及缩略语的定义。]
2 设计原则
[简要描述系统内部设计的原则及外部系统的接口设计原则。
例如,可能的系统内部设计原则包括但不限于:高响应速度原则(系统的响应速度需要优先考虑的原则),用户交互界面友好优先考虑的原则,可参数化配置原则(通过参数进行功能配置,避免代码升级的原则);可能的接口设计原则包括但不限于:符合通用标准的原则(采用业界通用标准的原则);
该部分可节选架构设计说明书中的相关内容,并且不得与架构设计说明书中的设计原则相冲突。]
3 设计策略
[描述概要设计的设计策略,这部分要求突出整个设计所采用的方法(是面向对象设计还是结构化设计)。可节选架构设计中的相关内容]。