最新软件设计文档模板解析.docx

PAGE PAGE # 软件设计文档模板 **项目 需求详细设计 **项目组 2016年12月15日 变更记录 日期 版本 号 修改人 变更内 容描述 审核人 批 准 人 2016 12-15 1.0 初稿 目录 目录 一、导言 TOC \o 1-5 \h \z \o Current Document 1＞编写目的 4 \o Current Document 2、 背景 4 \o Current Document 3、 术语定义 4 \o Current Document 4、 参考资料 5 \o Current Document 5、 约定 5 \o Current Document 二、总体设计 5 系统概述 2、设计策略 、导言 1、编写目的 简略说明文档编写的目的、作用，并指出项目组将以此文档为依据指导系 统的开发及编码工作。 2、背景 说明一下项目建设背景，着重说明项目建设的必要性，并概要介绍项目实 现的主要功能模块。 3、术语定义 文档中所使用专业术语的定义、文档中所使用简称的说明等。 4、参考资料 系统中引用参考资料说明。 5、约定 文档中使用标记符号、特殊颜色作标注的原因或者对某些有出入的内容 作出解释等。 二、总体设计 1、系统概述 概述系统的主要模块，及各个模块实现的主要功能。 2、设计策略 系统的设计策略，即设计原则。说明系统设计时定下的规范和考虑因素, 比如数据库设计规范、编码规范以及系统扩展性、安全性、易用性等。 3、系统总体结构 1＞部署架构图 □ r I 云昌矗、 音户闻 厂区舌理需 如: 2＞功能结构图 客尸誉理货运公司如:!_____________________ ________________ 客尸誉理 货运公司 如: !_____________________ ________________ 3＞ 3＞技术架构图 如:KFlbitftF^t户捕必乩肝上貞wiiEMitfritteWHI4MMRKFlbitftF^eWHI4建1 *1-*C! 1 如: KFlbitftF^ t户捕必乩肝上貞 wiiEMitfritt eWHI4 MMR KFlbitftF^ eWHI4 建 1 * 1- * C! 1 业另凰另屠 I tl NJPO ( 禹芹UH -4 4、公共设计 通用功能、通用函数、公用帮助、系统全局参数等的设计。 三、功能设计 设计文档的主要内容，按模块、功能的顺序逐级写明实 现内容。 1、客户管理模块 1＞客户投诉功能 此功能用于处理客户投诉，分为客户投诉信息录入和客户投诉信息处理两 个流程。举例说明： 1＞客户信息录入。 本功能为客户投诉的录入界面，由客服人员将客户的投诉意见录入本系统 中，以备查和处理。 本功能可以录入客户姓名、客户电话、客户投诉分类、客户投诉意见等。 2＞ 界面定义。 该功能包含两个界面，一个是客户信息投诉列表，另一个是客户投诉信息 明细页面。 客户信息投诉列表，输出列为单据 ID 、投诉人类型、投诉人名称、联系电 话、投诉人车牌号、被投诉人信息、录入日期、录入人员等等。如图： 客户投诉信息明细，是客服录入客户投诉信息的界面，如图: 3＞界面说明 1 ）界面元素: 对象 名称 类型 显示信 r 丿息 [ 值] 取 控制规则 其它 说明 单据 ID 输入 框 自动生 成的编 号 不可编辑，输入 框置灰 客户 编号 输入 框 如果客 户输入 车牌 号，则 自动带 出此值 不可编辑，输入 框置灰 客户 名称 输入 框 必输，输入长度 20 投诉 人类 型 下拉 框 默认显 示：客 户 客 户； 经 销商； 必输 投诉 人车 牌号 码 输入 框 非必输，如果输 入该项后，自动 带出客户编号 项的值  投诉 人身 份证 号 输入 框 非必输 联系 电话 输入 框 必输 被投 诉人 类型 下拉 框 默认显 示：经 销商 1，经 销商； 2财务 公司 专员 必输 被投 诉人 姓名 输入 框 必输 投诉 原因 输入 域 必输 2 ）按钮说明。 新增：点击新增，界面跳转到空白明细界面。 修改：首先检验，必须选中一条数据，如果选择多条，默认取第一条数据, 将相关参数传递给明细界面，明细界面获取之后展示在页面上 删除：可选择多条数据进行删除。 4＞数据对象设计。即表结构设计。 四、补充变更设计 根据业务发展需要做调整的内容或者系统附加的一些 功能设计。 五、数据对象设计 单独提供数据结构文档作为附件。