系统设计说明书_项目名称(概设详设计数据库设计合并时使用)

系统设计说明书V1.0项目代号CRF-XXXXX发布版本1.0文档类型docx发布日期编制人编制日期审核人审核日期批准人批准日期 项目名称系统设计说明书V1.0版本修订记录版本号发布日期修订人修订说明第2页，共15页 系统设计说明书 目录1概要51.1目的51.2背景51.3术语和缩略语51.4参考资料52需求规定53总体设计63.1系统架构图63.2整体流程图64接口设计74.1接口定义74.2核心交互序列图75数据结构85.1逻辑结构设计85.2物理结构设计86运行设计86.1运行环境86.1.1硬件及网络环境86.1.2软件环境86.2运行模块组合96.3运行控制96.4运行时间96.5人工处理过程97安全性设计98非功能性要求98.1性能指标要求98.1.1峰值处理能力108.1.2数据存储容量108.2兼容性要求108.3可靠性及可用性108.4可维护性109系统出错处理的设计109.1出错信息109.2补救措施109.3系统维护设计1110模块#详细设计（可选）1110.1功能11110.1.1业务逻辑描述1110.1.2功能的设计1110.1.3功能逻辑流程描述1110.1.4关键程序详细设计1110.2功能21111建模分析（可选）1111.1系统用例1111.1.1用例图1111.1.2用例说明1211.2对象模型1211.2.1总体类图介绍1211.2.2对象描述1211.2.3属性1311.2.4方法1312数据库详细设计（可选）1312.1存储过程#/触发器#的名称13系统设计说明书1 概要1.1 目的说明编本文档的目的及预期读者。1.2 背景项目名称开发者项目背景1.3 术语和缩略语1.4 参考资料资料名称资料来源2 需求规定列出系统所要完成的需求要点，可以根据需求形式调整表格形式，也可以直接去除表格用文字描述。序号需求简述123453 总体设计3.1 系统架构图对整体架构方案进行说明。概述架构设计的方法，核心模块的设计思路、本系统的架构约束，并分析系统的架构对关联系统的影响（关键功能、性能、可用性等），评估可能存在的技术风险。3.2 整体流程图描述系统的主要业务流程。可以使用图表的形式说明本系统的基本设计概念和处理流程。4 接口设计4.1 接口定义【用户接口】说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。【内部接口】说明本系统之内的各个系统元素之间的接口的安排。【外部接口】说明本系统同外界的所有接口的安排包括软件与硬件之间的接口，本系统与各支持软件之间的接口关系。接口1：功能描述调用函数被调用函数输入参数输出参数说明接口2：功能描述调用函数被调用函数输入参数输出参数说明4.2 核心交互序列图用时序图或其它类似图形描述上述各模块相互协作完成本故事的处理流程。5 数据结构用图表或伪码说明本系统涉及到的重要数据结构5.1 逻辑结构设计给出本系统内所使用的每个数据结构的名称、标识符以及它们中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。5.2 物理结构设计给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。6 运行设计6.1 运行环境简要地说明对本系统的运行环境（包括软硬件环境和支持环境）的规定。6.1.1 硬件及网络环境简要说明本项目的硬件及网络环境1.网络环境描述网络环境要求，包括路由器、防火墙、子网、宽带、网速要求等2.硬件环境（硬件配置要求）描述服务器配置，包括运算和存储资源等，进行容量评估，包括磁盘、内存、CPU容量等6.1.2 软件环境简要说明本项目服务器端软件环境1. 操作系统2. 数据库服务器软件3. 其他支撑软件6.2 运行模块组合 说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。【例如：某自动报价系统，需求要求总代理可以看到最优价，并可以设定给二级代理的价格。因此当系统运行在二级代理的模式的时候将看不到系统的最优价格，也不需要“设定二级代理价格”的支持。】6.3 运行控制说明每一种外界的运行控制的方式方法和操作步骤。【例如：某网络系统，是否进行网络通信需要有一个按钮来控制，因此要特别说明，如果这个按钮没有被打开，系统就无法进行网络通信。】6.4 运行时间说明每种运行模块组合将占用各种资源的时间。【例如：某网络版的管理软件，模块A在进行某数据表进行操作时，将一直控制着该数据表，直到操作完成。在此期间，其他模块不能对该数据表进行包括读取在内的操作。】6.5 容灾设计说明每种运行模块组合将占用各种资源的时间。列出本系统的容灾要求（RPO、RTO、优先级），描述本系统依赖的环境容灾方案要求（网络环境、防火墙策略、应用主机、数据库、存储等）7 安全性设计对系统的网络安全、数据安全等进行设计1. 网络安全；2.数据安全；8 非功能性要求系统的非功能性的需求，可根据项目实际情况选择阐述以下非功能性需求中某些部分8.1 性能指标要求8.1.1 峰值处理能力描述系统的时间特性方面能力，需通过具体场景体现。如：1.并发用户：支持?人同时在线，并支持?人并发访问；2.响应时间：静态页面在?秒钟内完整显示、查询等动态页面在?秒内完整显示。3.后台管理性能要求：支持?人并发访问，?秒内显示完整页面，部分批处理任务，原则上作为后台进程执行，不占用编辑时间，不影响编辑正常操作。8.1.2 数据存储容量定义系统的各种容量参数。8.2 兼容性要求8.3 可靠性及可用性8.4 可维护性9 系统出错处理的设计9.1 出错信息用表格方式说明每种可能的出错或故障情况出现时，系统输出信息的形式，含意及处理方法。操作步骤 提示信息备注 9.2 补救措施说明故障出现后可能采取的变通措施，包括：后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；故障技术 说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。9.3 系统维护设计说明为了系统维护的方便而在程序内部设计中做出的安排，包括在程序中专门安排于系统的检查与维护的检测点和专用模块。10 模块#详细设计（可选）10.1 功能110.1.1 业务逻辑描述充分理解需求的基础上，对本功能点相关的业务逻辑进行描述。10.1.2 功能的设计在业务逻辑描述的基础上进一步对功能细节进行设计。10.1.3 功能逻辑流程描述根据需要使用文字或图表的形式对本功能点相关的功能逻辑流程进行描述。10.1.4 关键程序详细设计1. 输入、输出项给出对每一个输入、输出项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入输出的形式等。2. 算法详细说明本程序所选用的算法，具体的计算公式和计算步骤。3. 流程逻辑 用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。10.2 功能211 建模分析（可选）此章各图仅为建议章节。即使不用UML图，只要能够描述清楚也可，不拘于形式。11.1 系统用例11.1.1 用例图XX用例（名称）11.1.2 用例说明11.2 对象模型11.2.1 总体类图介绍11.2.2 对象描述11.2.3 属性可先定义相关的数据结构。也可以不使用表格、而使用伪代码格式描述。表1 数据结构可见性属性名称类型说明（对属性的简短描述）11.2.4 方法下面针对每个方法进行说明。方法#的名称（1）方法描述函数原型方法的声明，包含可见性功能描述描述本方法的功能调用函数被本函数调用的函数清单（非系统函数）被调用函数调用本函数的函数清单（非系统函数）, 可选输入参数描述每个输入参数的含义、内存管理原则输出参数描述每个输出参数的含义、内存管理原则返回值描述返回值的含义抛出异常描述可能抛出的异常（2）实现描述使用伪代码、流程图（可选）等来描述本方法的详细实现。这部分是详细设计的重点。