概要设计说明书模板.docx

密级：内控 浪潮集团山东通用软件有限公司 *项目/系统概要设计说明书 *项目/系统概要设计说明书变更记录日期版本号修改人变更内容描述审核人批准人2010/08V1.0任丽霞初始版刘俊红魏代森2011/08V1.1任丽霞功能架构图中，增加对模块是开发、购买或重构的说明。乔梁刘俊红目 录1导言21.1编写目的21.2背景21.3术语定义21.4范围21.5参考资料22总体设计22.1系统概述22.2设计策略32.3系统总体结构32.3.1部署架构图32.3.2功能结构图42.3.3技术架构图52.4公共设计52.4.1公用组件设计62.4.2通用函数设计62.4.3公用帮助设计72.4.4统一约定72.5外部系统接口设计82.6内部模块关系及其接口关系82.7设计约束83功能设计93.1系统193.1.1功能一名称93.1.2功能二名称103.2系统2104非功能设计104.1系统效率优化设计104.2系统安全性设计115数据对象设计11 第 11 页 共 11 页1 导言 本文档中蓝色字部分是说明和指南，需要作者在正式文档中删除。本模版不适合的章节填写“无”，但不允许删除；作者可以根据实际情况增加章节内容。概要设计说明书描述*项目/系统软件系统总体结构设计的问题，包括整个软件系统的结构，模块划分，模块关系及接口关系等。1.1 编写目的 描述本文档所包含的概要设计的概述，编写目的等。例如：根据需求规格说明书对整个软件系统结构，模块划分、模块关系及接口关系编写详细说明，为进一步编写详细设计说明书打下基础。1.2 背景1.3 术语定义本节对文中出现的专业术语进行解释，以方便阅读者理解。将需求规格说明中的术语、缩写进行定义。包括用户应用领域与计算机领域的术语与缩写等。 在本文档中用到的数据对象用语描述前后要一致。1.4 范围本节描述了此文档的适用范围。1.5 参考资料本节描述了此文档的参考资料。说明需求规格说明使用的参考资料，如商务合同、用户领域的资料等，每一个文件、文献要有标题、索引号或文件号，发布或发表日期以及出版单位。2 总体设计2.1 系统概述描述指南：系统简述、软件设计的目标、确定系统设计的范围。在这里重点描述整个系统的设计目标，明确说明哪些是系统决定实现的哪些是不准备实现的，同时对于系统的非功能性的需求如性能、易用性等也需总体说明。2.2 设计策略描述指南：1) 描述在考虑系统的“可扩展”和“可复用”等方面所采取的方法和措施。例如：要实现的系统如是作为或将来作为公司产品的一部分集成时，在设计时就要考虑系统的复用和扩展，采用技术分别处理固定部分和变动部分，为产品的开发打好基础，还要考虑与公司现有产品的兼容问题；如没有共性仅仅是为客户定制，设计策略是不同的。2) 描述整个设计所采用的方法（是面向对象设计还是结构化设计）、系统的体系架构组成（例如客户/服务器结构、多层结构）以及使用到的相应技术和工具（例如Rose）。2.3 系统总体结构描述指南：概述或图示系统总体结构情况。要求提供系统总体结构、各子系统（包括模块间）结构及结构间关系描述，使用方框图显示主要组件及组件间的交互关系。2.3.1 部署架构图2.3.2 功能结构图描述指南：各模块的功能关联图，每个模块需要标注是购买、开发还是重用此消息平台模块：全部自主开发 2.3.3 技术架构图2.4 公共设计提取本系统中能够抽取出来统一处理、统一约定和说明的部分，减少设计和开发的重复。2.4.1 公用组件设计样例1组件名称组件说明组件接口参数接口说明注意事项物料实体获取基础物料实体获取公司ID、物料ID、条件公司物料实体获取。库存组织物料实体获取。样例2组件名称组件说明组件接口参数接口说明注意事项通信组件消息平台底层通信服务组件队列组件队列服务组件持久化组件持久化组件适配组件适配各种消息的组件2.4.2 通用函数设计样例交易码XDYwLxIfUse交易名称判断业务类型是否已使用功能简述根据业务类型判断是否已开始使用。入参psYwLxBh业务类型 （空表示所有）出参返回值（viRet）1表示开始使用0表示未使用相关表序号表名操作1XDYWLX（信贷业务类型）查询l 参数说明：业务类型：可以为空，表示所有业务类型。逻辑处理：略。2.4.3 公用帮助设计样例F_HELPF_HEBH说明条件XDYWLX001业务类型帮助无LSBZDWXD1结算中心具有查询权限的单位帮助LSBZDW_DWBH IN ()LSBZDWXD2结算中心具有操作权限的单位帮助LSBZDW_DWBH IN ()CodeItemsXD1贷款用途帮助SetID=D001ZJJGZDZJ4资金结构字典不分级XDXYLBXD1信贷信用类别（内部）XDXYLB_YWFW=1XDXYLBXD2信贷信用类别（外部）XDXYLB_YWFW=2XDDKHTXD1信贷贷款合同（内部）XDDKHTXD2信贷贷款合同（外部）2.4.4 统一约定样例通用说明1、 系统参数统一从公司参数表中取值，有特殊说明的，按照特殊说明进行处理。2、 业务单据编号规则，都需要按照资金中心进行获取。3、 所有申请单、合同的卡片显示窗口，数据项内容都根据业务模版定义中不同业务类型的申请单、合同模版生成。4、 所有审批功能都要通过GSP审批工作流实现，具体实现方式要视GSP情况而定，本文档中的描述只做参考。5、 所有帮助，统一使用通用帮助处理。6、 在更新单据状态的时候，需要检查单据原状态是否和数据库中该单据当前状态相同，如果不相同，返回错误信息“状态不符，不能处理”，否则，可以继续进行逻辑处理，在业务中没有描述的，统一按照该规则处理。7、 对于被退回的单据，都使用红色显示。8、 列表窗口类界面图例中的栏目列示受静态界面限制，可能不全，栏目的内容、顺序以界面内容说明为准。其他约定1、 对于下面文档中描述的当前操作员，是指系统登录的当前操作用户。2、 当前操作员的身份一律通过职责来判断，通过系统登录或职责切换的时候所获得的系统参数获得。3、 对于下面文档中描述的当前操作员对应的资金中心或当前资金中心或本资金中心等描述是指当前操作员当前职责所对应的资金中心，如果是成员单位操作员的职责，则资金中心为空。窗口操作过程中能够修改或删除别人做的单据，受系统参数统一控制2.5 外部系统接口设计描述指南：如果存在外部系统，描述本系统/子系统与外部系统的接口方式、接口的内容、处理方法。2.6 内部模块关系及其接口关系对模块进行划分，描述模块间及其接口关系。2.7 设计约束描述指南：1）系统设计中最主要的约束，这些是由客户强制要求并在需求说明书写明的。此处说明系统是如何来适应这些约束的。2）另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能辅助，那么系统可能还受到其它的约束。这种情况下，要求清楚地描述与本系统有交互的软件类型以及这样导致的约束。3）实现的语言和平台也会对系统有约束，同样在此予以说明。4） 对于因选择具体的设计实现而导致对系统的约束，简要地描述你的想法思路，经过怎么样的权衡，为什么要采取这样的设计等等。3 功能设计3.1 系统13.1.1 功能一名称3.1.1.1 处理过程设计描述指南：从内部实现的角度描述系统的处理过程，即系统如何动作的。需要描述每个控制对象的内部处理控制的过程。1、 界面处理：可引用需求规格中的界面，说明打开界面时系统对应的处理内容，及界面输入过程中的处理，复杂处理可使用数据流图。样例：进入主界面，列表框按照编号排序并默认选中第一条明细记录。卡片框显示第一条明细记录的信息。界面为只读。输入相关数据表：打开界面时显示数据的来源表输出相关数据表：数据保存和更新的表对象名称对应字段其它说明列出界面上各元素表述取数或保存对应数据库表及列名其他需补充说明的内容编号XDHTZD_HTBH名称XDHTZD_DWJC类别XDHTZD_DWLB业务日期XDHTZD_HTRQ2、 按钮处理：说明按钮中的逻辑处理，方便开发人员理解和验证。样例：增加：卡片窗口数据清空，前两个字段均为可编辑状态。XDDQZD_TYBZ默认0。作废：判断当前地区状态，如果已启用，将当前记录的XDDQZD_TYBZ字段设置成1，并记录当前年度到XDDQZD_TYND字段。如果作废，则该按钮为禁用状态。启用：判断当前地区状态，如果已作废，将当前记录的XDDQZD_TYBZ字段设置成0，将 XDDQZD_TYND字段置成空。；如果已启用，则该按钮为禁用状态。修改：状态，停用年度不能修改，其它为可编辑状态。删除：如果当前地区已使用，则不能删除。保存：进行检查：1、 编号，名称不能为空2、 编号不能重复通过检查，则保存界面内容。退出：退出界面。如果有修改内容尚未保存，给出提示信息。3.1.1.2 补充说明描述指南：如果需要其他补充说明的内容请在这里描述，比如此项功能对系统其它模块产生的影响及措施。3.1.1.3 待解决问题描述指南：在这里描述设计中遇到的待确定、待解决的问题以及需要后序人员完善的内容。3.1.2 功能二名称。3.2 系统2。4 非功能设计4.1 系统效率优化设计描述指南：在设计时就要考虑系统的运行效率，提高系统性能。使用公司关于性能优化（例：开发人员手册-性能优化篇）方面的规范，在此基础上，描述对于本系统在运行效率方面的考虑。例如: 描述从提高数据访问效率方面在设计数据库和使用SQL语句时所采取的措施和方法。比如：是否允许使用存储过程、触发器等；书写SQL的方法；对索引的要求等；关于对事物处理和并发处理的要求等。可以引用公司相应规范的内容要求。4.2 系统安全性设计描述指南：在设计时就要考虑系统运行的安全，特别是基