系统设计说明书(项目)模板.doc

系统设计说明书密级： 编号：版本号：生效日期：批准/日期： 审核/日期：_编制/日期：_ 修改序号修改理由/内容修改/日期批准日期说明：该页是该模版的版本信息，在项目使用中，可将该页删除掉修订历史生效日期版本号版本说明作者审核批准XX系统设计说明书说明： 1、 本文见适用于采用OO方法的系统设计；2、 本文件中“”中内容为说明文字，请在文件拟制时替换或删除；3、 若文中某章节内容可省略、不需要或适用，请保留该标题，并根据实际在内容部分写明“略”、“勿需”或“不适用”等，同时适当说明原因。目录1引言51.1目标51.2范围51.3术语和缩略语51.4参考资料52整体说明52.1简介52.2系统目标和约束53整体设计63.1系统架构63.2用例视图63.2.1用例63.3逻辑视图73.3.1逻辑视图73.3.2分层73.3.3架构模式和设计机制83.4部署视图83.5数据视图93.6公共平台使用94接口设计94.1.1接口说明95数据库设计105.1数据库说明105.2数据库概念模型设计105.2.1数据实体描述105.2.2数据实体-关系图105.3数据库逻辑结构设计115.4数据库物理结构设计116数据转换116.1数据转换方案127与其他系统之间的依赖关系128质量及其它方面128.1可维护性128.2安全性128.3健壮性138.4可扩展性/灵活性138.5稳定性/可靠性138.6算法合理性与性能优化138.7界面友好性139附件13系统设计说明书1 引言1.1 目标本节确定此系统设计说明书在整个项目文档中的作用或目的，并对此文档的结构进行简要说明。应确定此文档的特定读者，并指出他们应该如何使用此文档。1.2 范围简要说明此系统设计说明书适用的范围和影响的范围。1.3 术语和缩略语列出文中全部术语并给出定义；列出文中全部缩略语，并给出全称和定义。序号术语/缩略语全称和说明.4 参考资料列出本设计说明中所参考或引用的所有文档或其他资料。每个参考资料应提供名称、版本号、出版/编制日期、出版单位/作者。2 整体说明2.1 简介在此简单介绍软件系统的整体情况，在此简要说明此系统的职责、目的或者内容。2.2 系统目标和约束本节说明对构架具有某种重要影响的软件需求和目标，例如：安全性、保密性、市售产品的使用、可移植性和重复使用。还应记录可能适用的特殊约束：设计与实施策略、开发工具、团队结构、时间表、遗留代码等。说明设计系统需要考虑的问题、遵循的约束。比如要遵循软件架构设计的要求，要遵循需求中分配到此子系统的特殊要求，要遵循统一的界面约束（如果有的话），要使用架构统一设置的数据库源，要使用架构统一设置的JAVA MAIL等3 整体设计3.1 系统架构以图形和文字的形式表述出该系统的整体架构，各个子系统之间的依赖关系，同时要描述各个部分使用到的具体技术。对于由于部分非功能性需求使用了特别的解决方案，应该在此准确表述。3.2 用例视图本节列出用例模型中精化的用例或场景，这些用例或场景应体现最终系统中重要的、核心的功能；或是在构架方面涉及范围很广（使用了许多构架元素）；或强调或阐明了构架的某一具体的细微之处。在此可以直接引用需求中的相关文档，比如ROSE模型、用例描述等，用例不用放图可以写引用文件图例：3.2.1 用例本节可以将所有用例通过ROSE文件提供。并通过几个精选的用例（场景）实现来阐述软件的实际工作方式，并解释不同的设计模型元素如何促成其功能的实现3.3 逻辑视图3.3.1 逻辑视图 用图形的方式显示此软件架构的分层、子系统、包之间的关系，并且加入必要的文字说明，特别是架构的分层、机制和模式的说明。在此，还需要将和本系统有接口关系的其它系统都表示出来，这样可以清楚的看到本系统和其它系统的接口逻辑视图，并且还需要将在本系统中负责接口的子系统表示出来。图例：3.3.2 分层在此说明逻辑分层的每一层和每一层中的包、子系统。对于每个重要的包，都用一个小节来加以说明，其中应包括该包的名称、简要说明以及显示该包中所有重要的类和包的图。 例如：应用层、业务层、中间层和系统层以及相关职责功能属性说明，实际使用中可以根据需要进行修改。3.3.3 架构模式和设计机制在此说明软件架构采用的核心模式，此模式形成整个软件架构的骨架。说明软件架构各相关设计机制的处理方案，包括2个部分，一是全局的设计机制，包括事务的处理、持续性的处理等；二是特殊、局部的设计机制，包括权限管理、OID生成、连接池，JSP2SB等，初始化操作、功能表等。说明软件架构通用的设计元素及提供的和相关服务。使用J2EE架构，STRUTS模式进行开发设计,Struts 1.1中的MVC实现示意图： 图解说明：其中不同颜色代表MVC的不同部分：红色（控制器）、紫色（模型）和绿色（视图） 3.4 部署视图本节说明用来部署和运行该软件的一种或多种物理网络（硬件）配置。请根据系统需求和公司规范描述相关的系统部署节点。你可以添加其他视图，如安全视图，来表达软件构架的其他特定方面。图例：3.5 数据视图从永久性数据存储方面来对系统进行说明。如果几乎或根本没有永久性数据，或者设计模型与数据模型之间的转换并不重要，那么本节就为可选。该部分是从整体上描述相关的数据存储方面的设计，具体的设计可以将Power Design等模型视图附在第五章节“数据库设计”部分。3.6 公共平台使用在此描述使用公共平台部分的功能。 功能需求、以及如何使用。 如果使用了公共平台，则在前面的逻辑视图中应该体现公共平台系统。若无使用，此节可略。4 接口设计4.1.1 接口说明接口名称规则描述提供者使用者备注在规则描述中要尽量采用准确明白的方式表达接口，可以直接引用类、方法来进行说明。使用者可以是人，也可以是其他系统或代码。5 数据库设计如无数据库独立设计的必要，本节可选。5.1 数据库说明使用的关系数据库的名称、版本、模式（采用哪种范式）例：使用的关系数据库的名称、版本：Oracle 8.1.7使用的模式：第二范式5.2 数据库概念模型设计该部分是详细描述数据库设计内容，视情况可将其他设计工具中的内容直接引入5.2.1 数据实体描述可用列表形式列出系统中的数据实体，并对其进行描述。5.2.2 数据实体-关系图 画出ER图可引用设计工具中的相关图例。图例：5.3 数据库逻辑结构设计具体描述数据库实体的设计，可以引用设计工具的相关逻辑视图和代码设计。字段名字段代码类型可为空默认值人员外出清单T_UM_OOF_LIST外出序列号SEQ_NONUMBER(12)N外出人员IDOUTGOER_IDVARCHAR2(30)N生效时间VALID_TIMEDATENSysdate预计返回时间SCHEDULE_BACK_TIMEDATEY到期自动收回权限AUTO_REVOKECHAR(1)NN外出授权清单T_UM_OOF_DETAIL外出序列号SEQ_NONUMBER(12)N授权人IDOUTGOER_IDVARCHAR2(30)N代理人IDAGENT_IDVARCHAR2(30)N代理系统SERVICEVARCHAR2(40)N代理角色AGENT_ROLEVARCHAR2(40)N角色是否重复IS_REDUPLICATECHAR(1)N注意：如有数据文件可直接引入，或者引入数据库脚本文件。5.4 数据库物理结构设计说明是否采用分布式数据库，数据库表如何分布。每个数据库服务器上建立几个数据库，其存储空间等安排数据库表的分配方法，例如：段、表空间的大小，数据区、索引区、排序区的安排。用户角色的划分方法、以及相应的权限（如系统管理员权限，普通用户权限等）6 数据转换如果项目涉及到系统新旧数据的转换，请填本节内容，如无，则不需要填写。历史数据转换的最终目标：数据完整、准确。完整：旧系统中的各种数据状态、标志、金额、文本、日期等各类信息，在新系统中有相应的体现，不会出现信息的缺失。准确：旧系统的各类信息，按新系统中的逻辑关系表示准确，状态、标志、金额、文本、日期等各类信息准确，后续处理不受影响。6.1 数据转换方案历史数据转换一般是在新旧系统（或功能）间进行，考虑到数据结构、业务控制逻辑、数据项目内容等方面的变化，为保证数据转换完整、准确，需要编制历史数据转换方案。在设计历史数据转换方案前，最好先分析生产数据中的各种情况，根据不同数据情况，确定数据清理和转换方案。该部分如果有需要，可以单独附上数据转换方案；若无此需要，则省略。7 与其他系统之间的依赖关系在此说明本系统和其它系统及包的依赖关系，要求说明依赖于其它系统的接口以及提供给其它系统的接口。对于需要操作到其他系统或者模块表的情况，在此应该详细描述对该表进行什么操作。推荐结合附图说明。8 质量及其它方面说明软件构架如何促成所有系统性能（而非功能，例如可维护性可、健壮性、可扩展性、灵活性、稳定性、可靠性、算法合理性与性能优化、技术与架构先进性、界面友好性可靠性、可移植性等）的实现。如果这些特征具有特殊的意义（例如在安全性或保密性方面的意义），则应该对它们进行详细的说明。8.1 可维护性系统维护的难易程度，故障恢复处理难易程度等。8.2 安全性系统的安全性方面需关注如下：采用何种操作权限控制、设备钥匙、密码控制、系统日志监督、数据更新严格凭证等多种手段防止系统数据被窃取和纂改？是否采用明文方式存放密码？程序中是否用常量来存放密码？系统中实现远程访问功能的模块是否也不能传送明文的密码，例如不能使用ftp，而要使用sftp？如果系统接受通过因特网的访问，用户口令验证和非公开的数据（如交易数据、客户信息、保单信息等数据）是否经过加密处理？加密程度是否达到SSL级别？系统产生的业务数据需要脱离系统跟外部交换的，在交换