软件设计说明书模板.

简介：
软件设计说明书版本：V1.0 文 档 编 号 保 密 等 级 作 者 最后修改日期 审 核 人 最后审批日期 批 准 人 最后批准日期 修订记录日期 版本 修订说明 修订人 目 录 1 引言 1 1.1 文档控制 1 1.2 目的 1 1.3 范围 1 1.4 定义、首字母缩写词和缩略语 1 1.5 参考资料 1 1.6 概述 1 2 整体说明 1 2.1 业务背景 1 2.2 功能模型 1 2.3 用例模型概述 12.3.1 子系统一 1 2.4 假设和依赖关系 1 3 包1：出入库 2 3.1 冲补帐务－样例1 23.1.1 系统用例 23.1.2 类关系图 23.1.3 类图 33.1.4 顺序图 4 3.2 冲补入库单－样例2 43.2.1 入库单冲账 43.2.2 入库单补账 6 引言 文档控制 目的 范围 定义、首字母缩写词和缩略语 参考资料 概述 整体说明 业务背景[此小节应说明软件的业务背景，包括组织机构、业务流程等。] 功能模型[此小节应说明用例包的组织，以用例包的形式来表达软件的功能。] 用例模型概述子系统一用例图[此小节应说明此子系统下的用例图。]主角列表[此小节以列表的形式说明此子系统相关的主角。]用例列表[此小节以列表的形式说明此子系统相关的用例。] 假设和依赖关系[本节说明所有重要的技术可行性假设、子系统或构件可用性假设，或者可作为此文档所述软件可行性的基础的其他与项目有关的假设。] 包1：出入库画出包图、核心业务处理流程、状态转换图来说明核心业务的工作方式。 冲补帐务－样例1系统用例类关系图类图实体类边界类控制类顺序图分仓保管帐建帐处理流程备注：去掉价位一栏；收获年限改为“年限“，入库年限改为非必输项；国别改为必输项；等级改为非必输项；增加建帐的修改功能：只能修改等级、入库年限、产地。 冲补入库单－样例2入库单冲账前台界面名称：account_grainin_strike.jsp界面说明：序号 界面名称 表 字段 字段含义 备注1 编号 入库单 RC_RKD_RKDBH 入库单编号 顺序号 入库单 RC_RKD_SXH 顺序号 计划安排表 入库单 RC_RKD_RKJHAPBNM 入库计划安排表内码 需要转化为编号 计划明细 入库单 RC_RKD_JHMXNM 计划明细内码 需要转化为编号 入库通知单编号 入库单 RC_RKD_ZGKRKTZDNM 直管库入库通知单内码 需要转化为编号 客户名称 入库单 RC_RKD_KHNM,RC_RKD_KHMC 客户名称客户内码 合同号 入库单 RC_RKD_HTNM, RC_RKD_HTH 合同号合同内码 到库时间 入库登记信息 RC_RKDJXX_DKSJ 到库时间 收获年份 入库单 RC_RKD_NX 年限 等级 入库检验信息 RC_RKJYXX_WLDJNM 物料等级内码 后台服务功能简介 入库账务服务包名 com.digitalchina.zcl.stock.account类名 AccountGraininServer方法名称 参数 返回值 描述 入库单补账前台界面名称：account_grainin_repair.jsp界面说明：序号 界面名称 表 字段 字段含义 备注1 编号 入库单 RC_RKD_RKDBH 入库单编号 顺序号 入库单 RC_RKD_SXH 顺序号 扣杂 入库检验信息 RC_RKJYXX_KZZ 扣杂质(%) 扣水% 入库检验信息 RC_RKJYXX_KSF 扣水份(%) 备注 入库检验信息 RC_RKJYXX_JYYJBZ 检验意见备注 3 选择类型 入库检验信息 RC_RKJJXX_JJLX 检斤类型 0，称重；1，标准包 毛重 入库检验信息 RC_RKJJXX_MZ 毛重 水分扣量 入库检验信息 RC_RKJJXX_SFKL 水分扣量 杂质扣量 入库检验信息 RC_RKJJXX_ZZKL 杂质扣量 其它扣量 入库检验信息 RC_RKJJXX_QTKL 其它扣量 后台服务功能简介 入库账务服务包名 com.digitalchina.zcl.stock.account类名 AccountGraininServer方法名称 参数 返回值 描述补账repairAccount 被补入库单内码 入库单补账；根据被补单据产生一笔单据（RC_RKD）：红单标志为蓝单；补帐标志为1补帐补帐单据内码为被补单据内码；补帐日期为当前日期；审核标志为未审核；能否记保管帐为1能；能否记统计帐为1能；保管帐记帐标志为未记帐；统计帐记帐标志为未记帐；删除标志为未删除；制单时间为当前时间；其余要素用户录入；### 软件设计说明书模板解析#### 一、引言##### 1.1 文档控制文档控制部分主要用于管理文档的版本控制、修订记录等。这部分通常包含以下信息：- **文档编号**：用于唯一标识该文档的编号。- **保密等级**：根据文档内容的重要性设定的不同级别的保密要求。- **作者**：负责撰写文档的主要人员。- **最后修改日期**：最后一次对文档进行修改的日期。- **审核人**：负责审核文档内容的人员。- **最后审批日期**：最后一次文档被正式批准的日期。- **批准人**：有权批准文档的高级管理人员。- **修订记录**：记录文档历次修订的信息，包括日期、版本号、修订内容及修订人。##### 1.2 目的文档的目的在于提供软件设计阶段的详细描述，帮助开发团队理解软件的结构、功能以及实现细节。这有助于确保开发过程中的沟通顺畅，避免因理解不一致而导致的问题。##### 1.3 范围明确了文档覆盖的内容范围，即哪些部分将被详细描述，哪些部分仅做简要提及。##### 1.4 定义、首字母缩写词和缩略语文档中可能会使用特定的专业术语、缩写词或缩略语，这部分需要定义这些术语的具体含义，以便读者能够准确理解文档内容。##### 1.5 参考资料列出在编写文档过程中参考过的外部资源，如书籍、网站或其他文档。##### 1.6 概述简要介绍整个项目的背景、目标及预期成果，为后续内容提供一个宏观的视角。#### 二、整体说明##### 2.1 业务背景业务背景部分描述了软件所处的业务环境，包括但不限于：- **组织机构**：描述组织的架构、职责划分等。- **业务流程**：详细介绍现有的业务流程，包括输入、处理步骤及输出等。##### 2.2 功能模型功能模型描述了软件的功能组成及其之间的关系，主要通过用例包的形式来呈现。每个用例包代表了一组相关联的功能，用例包之间可能存在依赖关系。##### 2.3 用例模型概述用例模型是描述系统行为的一种常用方法，它从最终用户的视角出发，定义了系统应当如何响应用户的需求。这部分主要包括：- **子系统一**：具体说明了该子系统下的用例图，用例图展示了各个用例及其参与者之间的关系。- **主角列表**：列出参与该子系统的各种角色。- **用例列表**：以列表形式展示该子系统中的所有用例。##### 2.4 假设和依赖关系明确指出在设计过程中做出的各种假设条件，以及软件开发成功所依赖的外部因素。例如，特定的技术平台、第三方服务的可用性等。#### 三、包1：出入库出入库模块是软件中的一个重要组成部分，主要负责处理商品的入库和出库业务。##### 3.1 冲补帐务－样例1冲补帐务是指在发生错误操作后，通过冲销原操作并重新进行正确的操作来修正错误的过程。- **系统用例**：描述了冲补帐务的具体应用场景，例如，在发现某笔入库操作错误后，进行冲销操作。- **类关系图**：展示了冲补帐务涉及到的主要类及其相互之间的关系。- **类图**：进一步详细地描述了每个类的属性和方法。 - **实体类**：表示现实世界中的对象，如商品、订单等。 - **边界类**：负责处理用户交互，如前端界面的显示逻辑。 - **控制类**：协调实体类和边界类的行为，如业务逻辑处理。- **顺序图**：展示了冲补帐务处理过程中的对象间的交互序列。##### 3.2 冲补入库单－样例2入库单冲账和补账分别对应于冲销原入库操作和重新录入正确的入库数据。- **入库单冲账** - **前台界面**：提供了用户与系统交互的界面，包括录入必要的信息。 - **后台服务**：处理用户提交的数据，并执行相应的业务逻辑，例如，更新数据库中的记录。- **入库单补账** - **前台界面**：同样提供了用户录入必要信息的界面。 - **后台服务**：根据用户提供的信息生成新的入库单记录，更新系统状态。通过上述解析，我们可以看出这份软件设计说明书模板涵盖了软件开发过程中的关键环节，从项目背景、需求分析到设计阶段的各个方面都做了详尽的规划。这对于指导软件开发团队高效完成项目具有重要意义。