面向对象分析文档模板

面向对象的软件开发方法面向对象的软件开发方法 姓 名 张法晏 班级名称 智科 2 指导教师 刘卫平 实验日期 2016 4 25 日期日期版本版本描述描述作者作者 2016 年年 4 月月 目目 录录 1 概述 3 1 1 系统简述 3 1 2 软件设计目标 3 1 3 参考资料 3 2 术语表 4 3 用例 4 4 设计概述 此处请用简单的结构化描述 4 4 1 简述 4 4 2 系统结构设计 4 4 3 系统界面 5 4 4 约束和假定 5 5 对象模型 5 5 1 类定义 5 5 2 类关联描述 6 5 3 对象模型图 6 6 对象数据字典描述 6 6 1 子系统 1 中的对象 7 7 动态模型 8 7 1 场景 Scenarios 8 7 2 事件定义 Events 8 7 3 状态图 9 8 功能模型 9 8 1 确定输入输出与事件关系 9 8 2 功能模型图 9 9 数据库定义 9 10 部署图 9 11 非功能性需求 9 12 辅助文档 10 13 词汇索引 10 3 1 概述概述 1 1 系统简述系统简述 系统来源或者背景 系统要完成什么任务 所面向的用户 系统运行的环 境的简短描述 这部分主要来源于需求说明书的开始部分 1 2 软件设计目标软件设计目标 这部分论述整个系统的设计目标 明确地说明要实现哪些功能 对非功能性的需求例如性能 可用性 安全性 可靠性 可移植性等 亦 需提及 需求规格说明书对于这部分的内容来说是很重要的参考 看看其中明 确了的功能性以及非功能性的需求 这部分必须说清楚设计的全貌如何 务必使读者看后知道将实现的系统有 什么特点和功能 在随后的文档部分 将解释设计是怎么来实现这些功能的 1 3 参考资料参考资料 列出本文档中所引用的参考资料 至少要引用需求规格说明书 格式 如下 序号 作者 书籍或者论文名称 出版社或者期刊名称 出版年 月 如果是期刊后面必须有起止页码 格式如下 1 董国林 刘鑫 基于 STC 单片机的指纹考勤系统设计 工业控制计算机 2012 11 25 110 111 2 林 巴斯等 软件构架实践 清华大学出版社 2003 8 4 2 术语表术语表 对本文档中所使用的各种专业术语 容易引起歧义的术语以及自定义的术 语进行说明 如果一些术语在需求规格说明书中已经说明过了 此处不用再重 复 可以指引读者参考需求说明 3 用例用例 3 1 用例图用例图 3 2 用例描述用例描述 此处要求系统用用例图表述 UML 对每个用例 正常处理的情况 要 有中文叙述 用例中请将事件进行标注 用例序号 如 用例 1 用例名称 如 年度学籍审查 对该用例进行一句或两句简短描述 参与者 如 教学秘书 包含 扩展或泛化该用况所包含 可扩展的用例 以及包含或扩展它的用例 或者该用例的子用例或者父用例 前置条件启动此用况所必须具备的条件 后置条件在该用况结束时确保成立的条件 工作流描述该用况的细节 基本流与可选流 例外在该用况的执行的过程中可能引起的例外 限制在应用中可能出现的任何限制 注释提供可能对该用况是重要的任何附加信息 其中工作流的描述如下模板 研究生启动系统 系统提示研究生输入研究生证号和密码 研究生输入研究生证号和密码 系统进行验证 给出验证信息 若通过 若该生选择选课 系统在扩展点 选课 处执行用况 选课 若通过 若该生选择查看学分 系统在扩展点 查看学分 处执行用况 查看学分 5 4 设计概述 此处请用简单的结构化描述 设计概述 此处请用简单的结构化描述 4 1 简述简述 这部分要求突出整个设计所采用的方法 是面向对象设计还是结构化设计 系统的体系结构 例如客户 服务器结构 以及使用到的相应技术和工具 例 如 OMT Rose 4 2 系统结构设计系统结构设计 这部分要求提供高层系统结构的描述 使用方框图来显示主要的组件及组 件间的交互 最好是把逻辑结构同物理结构分离 对前者进行描述 别忘了说 明图中用到的俗语和符号 4 2 1 顶层系统结构顶层系统结构 4 2 2 子系统子系统 1 结构结构 4 2 3 子系统子系统 2 结构结构 4 3 系统界面系统界面 各种提供给用户的界面以及外部系统在此处要予以说明 如果在需求规格 说明书中已经对用户界面有了叙述 此处不用再重复 可以指引读者参考需求 说明 如果系统提供了对其它系统的接口 比如说从其它软件系统导入 导出数 据 必须在此说明 4 4 约束和假定约束和假定 描述系统设计中最主要的约束 这些是由客户强制要求并在需求说明书写 明的 说明系统是如何来适应这些约束的 6 另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能 辅助 那么系统可能还受到其它的约束 这种情况下 要求清楚地描述与本系 统有交互的软件类型 比如某某某数据库软件 某某某 EMail 软件 以及这样 导致的约束 比如只允许纯文本的 Email 实现的语言和平台也会对系统有约束 同样在此予以说明 对于因选择具体的设计实现而导致对系统的约束 简要地描述你的想法思 路 经过怎么样的权衡 为什么要采取这样的设计等等 5 对象模型对象模型 5 1 类定义类定义 提供整个系统的对象模型 如果模型过大 按照可行的标准把它划分成小 例如可以把客户端和服务器端的对象模型分开成两个图表述 对象图应该包含什么呢 在其中应该包含所有的系统对象 这些对象都是从理解需求后得到的 要 明确哪些应该 哪些不应该被放进图中 所有对象之间的关联必须被确定并且必须指明联系的基数 一对一 一对 多还是多对多 0 1 1 聚合和继承关系必须清楚地确定下来 每个图 必须附有简单的说明 可能经过多次反复之后才能得到系统的正确的对象模型 5 2 类关联描述类关联描述 请文字描述类关联 请画出初始对象图 7 5 3 对象模型图对象模型图 6 对象数据字典描述对象数据字典描述 在这个部分叙述每个对象的细节 它的属性 它的方法 在这之前必须从 逻辑上对对象进行组织 你可能需要用结构图把对象按子系统划分好 为每个对象做一个条目 在系统对象模型中简要的描述它的用途 约束 如只能有一个实例 列出它的属性和方法 如果对象是存储在持久的数据 容器中 标明它是持久对象 否则说明它是个临时对象 transient object 对每个对象的每个属性详细说明 名字 类型 如果属性不是很直观或者 有约束 例如 每个对象的该属性必须有一个唯一的值或者值域是有限正整数 等 对每个对象的每个方法详细说明 方法名 返回类型 返回值 参数 用 途以及使用的算法的简要说明 如果不是特别简单的话 如果对变量或者返 回值由什么假定的话 Pre conditions 和 Post conditions 必须在此说明 列出它 或者被它调用的方法需要访问或者修改的属性 最后 提供可以验证实现方法 的测试案例 6 1 子系统子系统 1 中的对象中的对象 6 1 1 对象 对象对象 对象 1 用途 约束 持久性 6 1 1 1 属性描述 属性描述 1 属性 属性 1 类型 描述 8 约束 2 属性 属性 2 6 1 1 2 方法描述 方法描述 1 方法 方法 1 返回类型 参数 返回值 Pre Condition Post Condition 读取 修改的属性 调用的方法 处理逻辑 测试例 用什么参数调用该方法 期望的输出是什么 7 动态模型动态模型 这部分的作用是描述系统如何响应各种事件 例如 可以建立系统的行为 模型 一般使用顺序图和状态图 确定不同的场景 Scenario 是第一步 不需要确定所有可能的场景 但是 必须至少要覆盖典型的系统用例 不要自己去想当然地创造场景 通常的策略 是描述那些客户可以感受得到的场景 7 1 场景 场景 Scenarios 对每个场景做一则条目 包括以下内容 场景名 给它一个可以望文生义的名字 场景描述 简要叙述场景是干什么的以及发生的动作的顺序 9 顺序图 描述各种事件及事件发生的相对时间顺序 7 1 1 场景 场景场景 场景 1 描述 动作 1 动作 2 7 2 事件定义 事件定义 Events 文字定义事件 画出事件跟踪图 画出事件流图 7 3 状态图状态图 这部分的内容包括系统动态模型重要的部分的状态图 可能你想为每个对 象画一个状态图 但事实上会导致太多不期望的细节信息 只需要确定系统中 一些重要的对象并为之提供状态图即可 7 3 1 状态图状态图 1 8 功能模型功能模型 8 1 确定输入输出与事件关系确定输入输出与事件关系 8 2 功能模型图功能模型图 功能模型图有很多 请分开表示 8 2 1 对象对象 1 的功能模型图的功能模型图 8 2 2 对象对象 2 的功能模型图的功能模型图 10 9 数据库定义数据库定义 10 部署图部署图