开发型系统概要设计说明书模板.doc

LOGO概要设计说明书文件编号：版本号：LOGO XXXX系统概要设计说明书修订页编号章节名称修订内容简述修订日期订前版本订后版本拟制审核批准12345678910111213141516目录1引言11.1目的11.2范围11.3文档约定11.4预期的读者11.5术语表11.6参考资料12总体设计12.1软件描述12.2设计约束22.3设计原则22.4体系架构22.4.1用例设计32.4.2逻辑设计32.4.3规模与性能42.5进程设计42.6部署视图53模块设计53.1逻辑设计53.2运行视图63.3技术实现73.4配置视图73.5配置文件74数据库设计74.1ER图74.2数据库表结构84.2.1大分类名称84.3数据库配置文件8概要设计说明书1 引言本节主要是描述软件体系结构设计说明书的目的、范围、相关术语、参考资料和本文档的摘要性介绍。软件体系结构设计属于高层设计文档，应当从整体角度进行阐述。1.1 目的软件体系结构设计说明书，将从设计的角度对系统进行综合的描述，使用不同的设计视角来描述其不同方面。在本小节中，将对该文档的结构进行简要的说明，明确该文档针对的读者群，指导他们正确的地使用该文档。1.2 范围说明该文档所涉及的内容范围，以及将影响的内容。1.3 文档约定本文档按如下章节组织：引言、总体设计、模块设计、数据库设计。大致描述一下每章作用。1.4 预期的读者1.5 术语表与其它文档一样，该文档也需要将本文档中所涉及的所有术语进行详细的定义。如果多份文档均需要相同术语，建议维护在一个项目词汇表中，这样就可以避免在每个文档中都重复很多内容。1.6 参考资料2 总体设计总体设计是概要设计说明中最为重要的部分，该章节从总体把握着系统设计方向。2.1 软件描述在本小节中，主要是说明软件体系结构设计说明书各个部分所包含的主要内容，说明本系统“是什么”，描述本系统的主要功能，阐述概要设计对需求的理解。2.2 设计约束描述设计时考虑到的约束条件，比如开发环境、运行环境、设计规范、实现规范等对概要设计的约束。2.3 设计原则描述要依据的设计原则。比如安全性、可移植性、可重用性、可扩展性等。2.4 体系架构本节需要描述系统的一个整体结构包括和周边系统、服务的调用关系及层次关系，下面给出两个例子引导读者理解，此处用图为主，辅以文字描述。例子1：Java OSS系统架构框图例子2：Android总体架构框图2.4.1 用例设计本节使用用例分析技术所生成的系统用例模型，描述其中的一些典型用例或场景。在该模型中纳入用例或场景，应该是系统中最重要、最核心的功能部分。2.4.2 逻辑设计在本小节中，列出逻辑视图的顶层图，该图将反映系统内子系统间关系，由哪些模块组成，每个模块之间的关系与协作。使得读者对整个软件体系结构有一个整体的了解。下面给出了一个例子说明该部分的绘制方法：另外，在本节中还应该选择一个主要的用例场景，对其进行描述与解释，以帮助读者了解软件的实际工作方式，解释不同的设计模型元素关联以及如何帮助系统实现。可以基于上述系统/模块，用时序图方式展示场景是如何实现的，并辅以文字说明。2.4.3 规模与性能描述针对系统的用户规模与性能方面相关的设计。需要按照以下顺序进行说明：1、 用户量估算2、 主要交易数据量估算3、 规模分析汇总表4、 性能指标推导结果2.5 进程设计本节主要描述该软件体系结构下，系统运时的情况。描述系统在执行时，包括哪些进程（包括线程、进程、进程组），以及它们之间是如何进行通信的、如何进行消息传递、接口如何。并详细说明进程控制结构。2.6 部署视图本节主要描述该软件系统部署后的样子，需要哪些硬件、支撑软件、网络环境。在每个物理节点上所运行的模块，它们之间是如何连接的，这些物理节点与进程之间的映射关系等等。填写开发、测试、生产三种配置环境的属性信息。3 模块设计3.1 逻辑设计逻辑设计主要是反映在该模块下子模块的划分及它们之间的关系，在逻辑视图中将列出组成本模块的子模块。并且对每个子模块对应的包分解成为类，并说明这些关键类的职责、关系、操作、属性。以类、类与类之间的协作、包与包之间的协作模型来表达系统的逻辑组织结构。子模块之间的关联结构示意图2.4.2已经有示例了，这里不再复述。下面给出包结构的示例，包结构体现了被设计的模块的OOA的思想。包图需要辅以文字说明。下面的例子给出了类结构的示例，类静态结构展示了模块实现的构想。3.2 运行视图和逻辑视图不同，运行视图更多的是以时序图的方式将逻辑视图中的核心类之间运行时关系表示出来，用以明确各个类运行期的职责。下面展示了时序图的示例，因为是概要设计，需要描述的是关键类之间的协同，至于MVC模式下的Controller-Service-DAO的调用关系，可以在详细设计中展开.3.3 技术实现本节主要从开发的角度来描述软件逻辑设计和运行设计相关实现技术的说明以及统一的规范要求。例如Maven构建、3层架构体系下表示层、逻辑层、持久层所用技术及要求等。3.4 配置视图在本小节中，说明系统各部分使用的到配置文件，配置项关系。3.5 配置文件详细描述系统运行需要的配置文件和配置项信息。4 数据库设计说明如何设计实现保存系统中需要持久化保存的数据。4.1 ER图表示ER逻辑关系。注：如果ER图大，要求分块粘贴ER图，避免因大图引起查看困难的情况及打印不清晰的情况。4.2 数据库表结构列出数据库表结构说明，样例参见下表。注：如果评审需要，本节建议使用Power Designer等Case工具生成。如果不是用来评审，直接用Power Designer等Case工具生成Html格式的Report，在此挂上链接即可，减少不必要的粘贴工作。4.2.1 大分类名称4.2.1.1 表名英文名表结构字段名称字段代码数据类型非空唯一说明IDIDNUMBER(10)TT名称NAMEVARCHAR2(100)TT工程标志CIVIL_FLAGCHAR(1)FF模板IDTEMP_IDNUMBER(10)TF编码CODEVARCHAR2(20)FF设备购置标志EQ