《第N次迭代—软件设计说明书》由会员分享，可在线阅读，更多相关《第N次迭代—软件设计说明书（12页珍藏版）》请在金锄头文库上搜索。
1、兹兹新能源科技股份有限公司 版权所有 设计说明书 V1 6 文档编号 ZIZI SD TEMP SJSMS YF 第 1 页 共 12 页 发布日期 实施日期 密密 级 内部公开级 内部公开 文档编号 文档编号 ZIZI SD TEMP SJSMS YFZIZI SD TEMP SJSMS YF 版版 本本 号 号 V1 6V1 6 发布日期 发布日期 实施日期 实施日期 模块模块 第第 N N 次迭代次迭代 软件设计说明书软件设计说明书 兹兹新能源科技股份有限公司兹兹新能源科技股份有限公司 兹兹新能源科技股份有限公司 版权所有 设计说明书 V1 6 文档编号 ZIZI SD TEMP SJS
2、MS YF 第 2 页 共 12 页 发布日期 实施日期 文件更改摘要 文件更改摘要 日期日期版本号版本号修订说明修订说明修订人修订人审核人审核人批准人批准人 兹兹新能源科技股份有限公司对本文件资料享受著作权及其它专属权利 未经书面许可 不得兹兹新能源科技股份有限公司对本文件资料享受著作权及其它专属权利 未经书面许可 不得 将该等文件资料 其全部或任何部分 披露予任何第三方 或进行修改后使用 将该等文件资料 其全部或任何部分 披露予任何第三方 或进行修改后使用 兹兹新能源科技股份有限公司 版权所有 设计说明书 V1 6 文档编号 ZIZI SD TEMP SJSMS YF 第 3 页 共 12
3、 页 发布日期 实施日期 目录目录 1 1概述概述 5 1 1编写目的 5 1 2设计范围简述 5 1 3名词术语 5 1 4参考资料 5 2 2软件设计目标软件设计目标 5 2 1目标范围 5 2 2功能性目标 5 2 3非功能目标 6 3 3设计概述设计概述 6 4 4结构设计结构设计 6 4 1层次结构框图 7 4 1 1顶层结构 7 4 1 2子模块 1 结构 7 4 1 3子模块 2 结构 7 4 1 4 7 4 1 5公共基础子模块结构 7 4 2模块职责设计 7 4 3模块交互设计 7 5 5子模块子模块 1 1 设计设计 7 5 1界面设计 7 5 1 1界面的组织 8 5 1
4、 2界面描述 8 5 1 3界面的切换逻辑 8 兹兹新能源科技股份有限公司 版权所有 设计说明书 V1 6 文档编号 ZIZI SD TEMP SJSMS YF 第 4 页 共 12 页 发布日期 实施日期 5 2程序接口 8 5 3数据模型 9 5 4数据流设计 9 5 5对象模型设计 9 5 5 1静态模型设计 10 5 5 2动态模型设计 10 5 6应对变化设计 11 6 6子模块子模块 2 2 设计设计 11 7 7约束和假定约束和假定 12 8 8遗留的问题遗留的问题 12 兹兹新能源科技股份有限公司 版权所有 设计说明书 V1 6 文档编号 ZIZI SD TEMP SJSMS
5、YF 第 5 页 共 12 页 发布日期 实施日期 1 概述概述概述 1 11 11 1编写目的编写目的编写目的 本说明书为了充分的理解 需求目标 采用面向对象的分析与设计的手段和原则 分析并 设计软件的实现方案 同时 本说明书在对需求和问题域的充分理解的基础之上分析可能的需 求变化点 以提高系统的可扩充性和可升级性 本说明书完成后 将作为后续开发 变更的基础 1 21 21 2设计范围简述设计范围简述设计范围简述 对本说明书设计的软件范围要完成什么 所面向的用户以及系统运行的环境的简短描述 可参考需求说明书的开始部分 1 31 31 3名词术语名词术语名词术语 1 41 41 4参考资料参考
6、资料参考资料 至少包含所基于的需求规格说明书 2 软件软件软件设计目标设计目标设计目标 这部分论述整个系统的设计目标 明确地说明哪些功能是系统决定实现而哪些时不准备实 现的 同时 对于非功能性的需求例如性能 可用性等 亦需提及 需求规格说明书对于这部 分的内容来说是很重要的参考 看看其中明确了的功能性以及非功能性的需求 这部分必须说清楚设计的全貌如何 务必使读者看后知道将实现的系统有什么特点和功能 在随后的文档部分 将解释设计是怎么来实现这些的 兹兹新能源科技股份有限公司 版权所有 设计说明书 V1 6 文档编号 ZIZI SD TEMP SJSMS YF 第 6 页 共 12 页 发布日期
7、实施日期 2 12 12 1目标范围目标范围目标范围 2 22 22 2功能性目标功能性目标功能性目标 该部分描述我所理解的功能目标 也就是说在该部分由 设计人员 站在自己的角度描述 从需求人员处得到的功能目标 以及在设计的过程中体会到的功能的目标 说明 该处的描述必须与设计完全一致 但不必与需求人员的描述或文档完全一致 其正 确与否和偏差留待本文档的评审会上决定 2 32 32 3非功能目标非功能目标非功能目标 该部分描述 设计人员 所理解的 关键的非功能性要求 也就是说在该部分由 设计人 员 站在自己的角度描述从需求人员处得到的 关键的非功能性要求 它是在设计的过程中必 须考虑以某种方式达
8、到的非功能性指标 其形式可以参考 目标 场景 决策表 如下 非功能性目标非功能性目标场景场景设计决策设计决策 性能性能 可用性可用性 可伸缩性可伸缩性 etcetc 3 设计概述设计概述设计概述 这部分要求突出整个设计所采用的方法 是面向对象设计还是结构化设计 系统的体系结 构 例如客户 服务器结构 技术框架以及使用到的相应技术和工具 例如 OMT Rose 4 结构结构结构设计设计设计 以框图的形式描述本功能模块中的各软件模块的划分 职责分配 层次结构 简单的数据 兹兹新能源科技股份有限公司 版权所有 设计说明书 V1 6 文档编号 ZIZI SD TEMP SJSMS YF 第 7 页 共
9、 12 页 发布日期 实施日期 流动描述 以外部模块代表其他的功能模块并将它们绘制在框图中 最好是把逻辑结构同物理结构分离 对前者进行描述 别忘了说明图中用到的俗语和符号 4 14 14 1层次结构框图层次结构框图层次结构框图 以层次结构框图的形式描述各软件模块在整个功能模块中的位置 以及相互之间的配合 并加以简单的数据流动描述 另外图中也应该包括外部模块 4 1 14 1 14 1 14 1 1顶层结构顶层结构顶层结构顶层结构 4 1 24 1 24 1 24 1 2子模块子模块子模块子模块 1 1 1 1 结构结构结构结构 4 1 34 1 34 1 34 1 3子模块子模块子模块子模块
10、2 2 2 2 结构结构结构结构 4 1 44 1 44 1 44 1 4 4 1 54 1 54 1 54 1 5公共基础子模块结构公共基础子模块结构公共基础子模块结构公共基础子模块结构 4 24 24 2模块模块模块职责设计职责设计职责设计 描述每个软件模块的职责 数据 与其它软件模块的交互 以及用户看到的效果 4 34 34 3模块交互设计模块交互设计模块交互设计 不管功能模块 还是公共服务 还是功能模块之间的集成程序 都可作为各个软件子模块 下面几个章节根据不同数量的软件子模块进行分别设计 5 子模块子模块子模块 1 1 1 设计设计设计 子模块的设计由于其职责不同 其设计的侧重点不同
11、 以下内部章节可参考 兹兹新能源科技股份有限公司 版权所有 设计说明书 V1 6 文档编号 ZIZI SD TEMP SJSMS YF 第 8 页 共 12 页 发布日期 实施日期 5 15 15 1界面设计界面设计界面设计 该处以用户界面为主 目标是以界面为核心描述功能的启动 操作过程 操作结果 并且 说明界面设计与数据模型的对应关系 外观设计方面 1 由用户控制界面 不强迫用户进入不必要的或不希望的动作 允许用户交互可以被中断和撤消 能够针 对不同熟练程度的用户定制界面 2 减少记忆负担 减少对用户短期记忆的要求 建立有意义的缺省 定义直觉性的捷径 快捷方式 界 面的视觉布局应该基于真实世
12、界的隐喻 3 保持界面一致 用户应能以一致的方式展示和获取信息 所有可视信息的组织均按照贯穿所有屏幕显 示所保持的设计标准 允许用户将当前任务放入有意义的语境 在应用系列内保持一 致性 备注 如果在需求规格说明书中已经对用户界面有了叙述 此处不用再重复 可以指引读备注 如果在需求规格说明书中已经对用户界面有了叙述 此处不用再重复 可以指引读 者参考需求说明者参考需求说明 5 1 15 1 15 1 15 1 1界面的组织界面的组织界面的组织界面的组织 界面与界面之间存在着聚合关系与先后顺序关系 此处从这个角度描述界面之间的关系 5 1 25 1 25 1 25 1 2界面描述界面描述界面描述界
13、面描述 每个界面的描述 此处提供界面的布局图 并描述输入的数据 如有可能请描述数据的来源 例如用户输入 文件读取或者数据库读取等等 输入和输出的数据验证以及用户操作验证的逻辑 用户的操作 顺序 本界面输出的数据 某些控件的响应逻辑 所属功能模块 兹兹新能源科技股份有限公司 版权所有 设计说明书 V1 6 文档编号 ZIZI SD TEMP SJSMS YF 第 9 页 共 12 页 发布日期 实施日期 5 1 35 1 35 1 35 1 3界面的切换逻辑界面的切换逻辑界面的切换逻辑界面的切换逻辑 以状态图的形式描述界面切换的顺序 并在状态变换的路径上描述导致界面切换的逻辑与 动作 5 25
14、25 2程序程序程序接口接口接口 本模块提供了对其它模块或系统的接口 5 35 35 3数据模型数据模型数据模型 此处的重点在与描述数据模型与界面 含程序接口 设计之间的对应关系 一个数据模型 中的实体可能会对应一个界面或一组有关系的界面 一个界面也可能用来展示一个或多个有关 系的数据模型中的实体 但本着从简的原则 不必描述实体的属性与界面元素之间的对应关系 总的来说原则就是应该在贴合用户的习惯的前提下由数据驱动界面 而不是由界面影响模 型 5 45 45 4数据流数据流数据流设计设计设计 如果一组界面之间存在关系 则以一组界面为单位否则以单个界面为单位 描述界面的前 提数据 数据在各界面之间
15、的流动 输出的数据 5 5 对象模型设计 使用 UML 图描述类 接口 协作以及它们之间关系 本着从简的原则 重点放在职责 协 作与关系上 并只描述系统主体的对象模型即可只描述系统主体的对象模型即可 除了传统的派生 关联 依赖关系之外 要 以关联关系的形式描述对象实例组织上的关系 也就是抽象意义上的容器与元素的关系 类图 只能描述静态的模型关系 动态的关系与配合过程交给协作图 时序图等动态图描述 一个一般性的设计思路是从问题域出发 将问题域的类与关系映射为软件中的类与关系 根据共同点 不同点抽象出接口与派生关系 根据需要增加控制类 关系类 业务逻辑类等 兹兹新能源科技股份有限公司 版权所有 设
16、计说明书 V1 6 文档编号 ZIZI SD TEMP SJSMS YF 第 10 页 共 12 页 发布日期 实施日期 初步的将职责分配给各个类 职责的分配应该符合封装性的原则以降低耦合性 并且要确保职 责分配的平衡 然后进一步的针对复杂的或关键的本软件模块的业务功能目标 使用协作图描 述各个对象的相互配合以完成功能 在这个过程中继续细分和调整各个类的职责 职责的分配应该清晰合理 并且职责的分配依据主要考虑问题域的本质规律 应该忽略业 务功能的影响或者使之尽量的小 从面向对象设计的基本原则出发评审对象模型的设计 例如 单一职责原则 开放 封闭原则 接口隔离原则 稳定依赖原则 最少信息原则 依赖倒置 原则等 5 5 15 5 15 5 15 5 1静态模型设计静态模型设计静态模型设计静态模型设计 5 5 1 15 5 1 1 主体对象 类 模型主体对象 类 模型 提供系统主体的对象模型 如果模型过大 按照可行的标准把它划分成小块 例如可以把 客户端和服务器端的对象模型分开成两个图表述 对象图应该包含主要的系统对象 这些对象都是从理解需求后得到的 要明确哪些应该 哪些不应该被放进图中 所
