管理系统编辑软件inaker详细设计说明书.doc

第 I 页 详细设计说明书模板详细设计说明书模板详细设计说明书模板详细设计说明书模板 第 II 页 目目 录录 第一章第一章 导言导言 2 1 1 目的 2 1 2 范围 2 1 3 术语定义 2 1 4 相关文档 3 1 5 参考资料 3 第二章第二章 功能模块实现设计功能模块实现设计 4 2 1 公用模块实现设计 4 2 2 专用模块实现设计 5 2 3 存储过程实现设计 6 2 4 触发器实现设计 7 第三章第三章 外部接口实现设计外部接口实现设计 8 3 1 外部接口 1 实现设计 8 3 2 外部接口 2 实现设计 8 第四章第四章 其它实现设计其它实现设计 10 4 1 部门角色授权设计 10 4 2 其它详细设计 10 第五章第五章 程序文件清单程序文件清单 10 详细设计说明书模板 V2 0 第 1 页 文档类别使用对象文档类别使用对象 文档类别文档类别 本文档是软件系统详细设计说明书的模板 是详细设计说明书的书写标准及规范 是技术文档 使用对象使用对象 该文档使用人员包括 系统分析人员 系统设计人员 系统编码人员 系统测试人员 系统维护人员 详细设计说明书模板 V2 0 第 2 页 第第一一章章 导导言言 本章对该文档的目的 功能范围 术语 相关文档 参考资料 版本更新进行说明 1 11 1 目目的的 本文档的目的旨在推动软件工程的规范化 使设计人员遵循统一的详细设计书写规范 节省制作 文档的时间 降低系统实现的风险 做到系统设计资料的规范性与全面性 以利于系统的实现 测试 维护 版本升级等 详细设计的详细程度 应达到可以编写程序的水平 1 21 2 范范围围 本文档用于软件设计阶段的详细设计 它的上游 依据的基线 是概要设计说明书 它的下游是 源程序清单及单元测试计划 并为单元测试报告提供测试依据 软件详细设计的范围是 各子系统的公用模块实现设计 专用模块实现设计 存储过程实现设计 触发器实现设计 外部接口实现设计 部门角色授权设计 其它详细设计等 按照三层结构 B A S 的布局 详细设计应从下面三个方面进行 数据库服务器上的面向数据的设计 数据字典物理设计 基本表物理设计 中间表物理设计 报 表设计 临时表物理设计 视图物理设计 存储过程物理设计 触发器物理设计 应用服务器上的面向业务逻辑的设计 接口数据设计 中间件设计 数据通讯传输设计 可视组 件设计 非可视组件设计 角色授权设计 功能点设计 功能列表设计 浏览器上的面向对象的设计 录入修改界面设计 浏览查询界面设计 登录注册界面设计 1 31 3 术术语语定定义义 序号序号术语名称术语名称术语定义术语定义 1 详细设计在概要设计的基础上 对其功能模块或部件进行实现设计 使编程人员据此能顺利书写出程序代码 2 存储过程存放在数据库服务器上的一段程序 它能被其它程序调用 以完成对数据库表的某些规定操作 详细设计说明书模板 V2 0 第 3 页 3 触发器存放在数据库服务器上的一段程序 当触发条件满足时它 就被执行 以完成对数据库表的某些规定操作 4 算法详细设计中实现某项功能的数据处理方法及处理流程 1 41 4 相相关关文文档档 1 源程序清单 2 单元测试计划及报告 3 用户使用手册 1 51 5 参参考考资资料料 1 软件需求规格说明书 2 概要设计说明书 3 软件合同 4 命名规范 详细设计说明书模板 V2 0 第 4 页 第第二二章章 功功能能模模块块实实现现设设计计 详细设计是面向模块的 或者说是面向部件 组件或构件 的 不是面向组织结构或部门单位的 一个组织或单位 根据角色的授权 可以挂上某些功能模块 若为 C S 或 B A S 结构 则要说明该模 块运行在哪一层上 2 12 1 公公用用模模块块实实现现设设计计 公用模块的提取与设计特别重要 设计它的目的是为了复用 因此它直接影响到系统 的详细设计 编程 运行的质量 公用模块设计包括如下内容 2 1 1 1 模块编号 G 1 2 模块名称 运行库 3 模块功能 用于各模块运行所需的库 4 模块背景描述 在该库里包含了各模块建立自己所需的数据和结构的各类程序及 软件 是整个软件运行及功能实现的基础和必备 是软件不可或缺的部分 5 模块算法设计 调用参数的描述 相应的选择数据 基调用的对应程序 操作对象的描述 该功能需要读入相应的选择数据 并根据相应的选择运行对应的程序 特别引用的描述 需要调用对应程序所需的数据 操作流程的描述 1 读入选择数据 并进行相应判断 2 根据选择运行程序 模块调用方法 在程序运行初期 利用使用者根据提示所选择的调用数据调用相关程序 当 输入数据正确时正常运行相关程序 如果数据不正确进行提示 并自动恢复至初始界面 IF 软件通过接口调用了计算机操作系统的某执行库 THEN 执行该指令 软件执行调用函数 ELSE IF 调用的库不存在 THEN 提示 运行库 xx 调用失败 缺乏相应的软件 END IF END IF 详细设计说明书模板 V2 0 第 5 页 7 模块编写者 黄健鸿 8 模块编写日期 2012 4 12 9 模块修订者 马博强 10 模块修订日期 2012 4 13 11 模块测试者 黄健鸿 12 模块测试日期 2012 4 15 2 1 2 1 模块编号 G 3 2 模块名称 软件升级 3 模块功能 用于更新软件 4 模块背景描述 软件运行的过程中数据或者是要求可能会发生变化 有时更有可能影响到软 件的正常运行和基本功能的实现 因此软件需要及时更新 即及时检查软件的运行情况 提醒用户更 新或者系统自动更新 5 模块算法设计 IF 用户双击 update 程序 IF 软件正在运行 提示 软件正在运行 请关闭软件 ELSE IF 互联网无法连接 提示 互联网连接失败 请重试 ELSE 软件通过互联网连接到官网的更新库 检查版本 IF 用户使用版本为最新 详细设计说明书模板 V2 0 第 6 页 THEN 提示 已使用最新的版本 ELSE 下载相关文件 进行覆盖 END IF END IF END IF END IF 调用参数的描述 用户向计算机操作系统发出的执行指令 操作对象的描述 update 软件 操作流程的描述 1 检查文件的内容 2 如果有新的数据 将其更新到现有文件 6 模块调用方法 内部调用 手动或者设置为自动更新 7 模块编写者 黄健鸿 8 模块编写日期 2012 4 12 9 模块修订者 马博强 10 模块修订日期 2012 4 13 11 模块测试者 黄健鸿 12 模块测试日期 2012 4 15 2 22 2 专专用用模模块块实实现现设设计计 1 模块编号 M1 1 2 模块名称 系统分析模块 3 模块功能 分析用户的操作 详细设计说明书模板 V2 0 第 7 页 4 模块背景描述 考虑到直接将用户设定编译生成子程序的过程过于复杂 为了简化子程序编 译模块的逻辑构成 利用 HTML 语言的思想 在 HTML 的语法和描述基础上 重新定义一些部分的 结构和命名 将用户的具体设定直接抽象为方计算机易于识别的 逻辑性较强的 中介语言 5 模块算法设计 调用参数的描述 将用户的操作数据作为参数 操作对象的描述 调用模块中的中介语言生成程序 特别引用的描述 引用相应的数据库 操作流程的描述 1 识别用户的操作模块传递的数据 2 调用模块中的中介语言生成程序以生成相应的语言 3 将生成结果显示在用户的 详细设计面板 中 并保存至程序的缓存中 具体编译结果如下 一个范例 IF 用户选择创建系统生成 THEN 让用户输入系统名 继续生成 IF 用户创建信息管理系统 副本 并分别署名为 一 和 二 THEN 继续生成 IF 用户在副本 一 中创建 页面 A 在副本 二 中创建 页面 B THEN 继续生成 IF 用户在页面 A 中某位置插入某大小的 层 内容为某图片 在 B 中某位置插 入某大小的层 内容为文本 THEN 继续生成 内容及描述 详细设计说明书模板 V2 0 第 8 页 内容及描述 END IF END IF END IF END IF 该语言对用户设计的描述细节 将于 HTML 语言类似 本软件将在 HTML 的语法和描述基础上 重新定义一些内容 例如 System Script Page page name linkstyle serv url dat attribute struct stru mem linkto log pri 系统 副本 页面 页面名 不同层内容之间的逻辑结构方式 线性 循环等等结构 服务器端的地址 数据属性 动态 静态 更改条 件等详见客户需求 结构体 结构体成员 层 中的数据与某结构体的联 系 设置登陆用户权限 如遇其他需求 另行确定 详细设计说明书模板 V2 0 第 9 页 6 模块调用方法 内部调用 用户执行相关操作时执行 7 模块编写者 黄健鸿 8 模块编写日期 2012 4 12 9 模块修订者 马博强 10 模块修订日期 2012 4 13 11 模块测试者 黄健鸿 12 模块测试日期 2012 4 15 1 1 编号 编号 2 中文名 文本编辑模块 3 模块功能 用户可以编辑多媒体文件 4 模块背景描述 当用户需编辑的相关媒体文件时 可以调用此模块 5 模块算法设计 IF 用户使用文本编辑工具 THEN 调用文本编辑工具程序 END IF IF 用户使用图片编辑工具 THEN 调用图片编辑工具程序 END IF 详细设计说明书模板 V2 0 第 10 页 IF 用户使用表格编辑工具 THEN 调用表格编辑工具程序 END IF 输入输出的描述 使用软件中的编辑工具 设计相应的媒体文件 而后在页面的相应 位置进行应用 操作对象的描述 主要针对各类媒体文件 特别引用的描述 编写特定的语言对系统已有的媒体文件进行直接调用 操作流程的描述 储存媒体文件 应用 注意事项 注意语言的正确编写 6 模块编写者 黄健鸿 7 模块编写日期 2012 03 21 2 32 3 存存储储过过程程实实现现设设计计 存储过程是一种特殊的公用模块 它在数据库服务器上执行 这里将它单独列出来 规定其详细 设计模板为 1 存储过程中文名 resource 信息存储 2 存储过程英文名 或拼音名 sq informaker resource saving 3 存储过程功能 存储过程用来记忆存储用户输入的信息 同时分析用户编辑的文 本和数据结构 提醒用户不要输入非法字符和不符合规范的多媒体文件 详细设计说明书模板 V2 0 第 11 页 4 存储过程算法 第一步 用户设计输入文本语言和多媒体文件 第二部 系统自 动调用函数检测输入的语言和多媒体文件 第三步 将用户设计的内容传递给设 计模块过程 5 存储过程调用方式 软件内部程序调用相关代码 6 存储过程入口参数 int char nchar text date time bit bool 等或用户自己创建的表值 参数 7 存储过程出口参数 必须是 OUTPUT 参数 8 模块编写者 王云飞 9 模块编写日期 2012 4 13 10 模块修订者 胡国进 11 模块修订日期 2012 4 17 12 模块测试者 黄健鸿 13 模块测试日期 2012 4 18 2 42 4 触触发发器器实实现现设设计计 触发器也是一种公用的模块 不过它是隐式执行 这里将它单独列出来 规定其详细设计模板为 14 触发器中文名 触发器 15 触发器英文名 或拼音名 16 触发器功能 主要用于审核与规范对数据库中表 触发器 视图等结构上的操作 比如在修改表 修改列 新增表 新增列等 它在数据库结构发生变化时执行 我们主要用它来记录数据库的修改过程 以及限制程序员对数据库的修改 比如 不允许删除某些指定表等 17 触发器算法 用形式语言详细描述其算法分析 使编程人员据此能顺利书写程序 详细设计说明书模板 V2 0 第 12 页 DELIMITER CREATE TRIGGER ON FOR EACH ROW BEGIN do something END 18 触发器激活条件 它在数据库结构发生变化时执行 19 触发器编写者 黄健鸿 20 触发器编写日期 2012 4 26 21 触发器修订者 写上修订者姓名 22 触发器修订日期 写上修订日期 yyyy mm dd 23 触发器测试者 写上测试者姓名 24 触发器测试日期 写上测试日期 yyyy mm dd 注意 过多地使用触发器反而会使系统的效率降低 因此 凡是能用存储过程代替触发器功能的 地方 一律用存储过程来实现 详细设计说明书模板 V2 0 第 13 页 第第三三章章 外外部部接接口口实实现现设设计计 3 13 1 外外部部接接口口 1 1 实实现现设设计计 1 接口中文名称 软件接口 2 接口英文名称 Software interface 3 接口内容与功能 与数据库连接 生成软件进行连接 4 接口硬件设施 扫描器 5 接口软件或中间件 RFID 中间件 信息以消息的形式 从一个程序传送到另一 个或多个程序 功能 传递信息 解译数据 安全性 数据广播 错误恢复 定 位网络资源 找出符合成本的路径 消息与要求的优先次序以及延伸的出错工具 等 使用方法 以应用程序为中心通过特定的 reader 读取数据 并传送至后端系统的 应用程序或数据库 从而达成与后端系统或服务串接的目的 6 接口的数据结构 非线性结构中的树形结构以及散列存储结构 7 接口的传输频率 兆 秒 1 8 接口带宽 64kb s 9 接口协议 Tcp ip udp http 等网络及数据传输协议 10 接口程序的算法分析 本软件采用当今主流的接口信息传输程序及算法主要以 visual C 为主 在此不再赘述 3 23 2 外外部部接接口口 2 2 实实现现设设计计 详细设计说明书模板 V2 0 第 14 页 1 接口中文名称 Rj 45 以太网接口 2 接口英文名称 Rj 45 internet interface 3 接口内容与功能 白橙 橙 白绿 蓝 白蓝 绿 白棕 棕的直通线或交叉线 通过线路与网络进行大量的数据调用与修改 4 接口硬件设施 计算机 交换机 集线设备 路由器 5 接口软件或中间件 RFID 中间件 信息以消息的形式 从一个程序传送到另一 个或多个程序 功能 传递信息 解译数据 安全性 数据广播 错误恢复 定 位网络资源 找出符合成本的路径 消息与要求的优先次序以及延伸的出错工具 等 使用方法 以应用程序为中心通过特定的 reader 读取数据 并传送至后端系统的 应用程序或数