OSSP体系-系统设计说明书模板.doc

XX-SP-SD-T03/V1.0【项目名称】系统设计说明书文件编号【项目编号】/ XX-SP-SD-T03文件状态 草稿 正式发布 正在修改当前版本拟 制日期审 核日期批 准日期 XXX公司修订历史记录 A - 增加 M - 修订 D - 删除变更版本号日期变更类型（A*M*D）修改人摘 要备注【模板使用必读：模板内容和页眉中【】包含内容为指导性的待替换文字，请在使用中替换为具体内容，或删除。文件提交时不得再含有这些内容。】目 录1引言51.1编写目的51.2背景51.3术语与缩写解释51.4参考资料52概述62.1系统任务62.1.1系统目标62.1.2运行环境62.1.3与其它系统关系62.2需求规定62.2.1功能需求62.2.2非功能性需求62.2.3约束和假定63总体设计73.1基本设计概念和处理流程73.2软件系统结构73.2.1模块A73.2.2模块B73.3功能需求与系统模块的关系73.4子程序与功能需求、系统模块间的关系73.5接口设计83.5.1用户接口83.5.2外部接口83.5.3内部接口83.6数据结构设计83.6.1逻辑结构设计要点83.6.2物理结构设计要点83.6.3数据结构与程序的关系94子程序设计94.1程序1（标识符）设计说明94.1.1程序描述94.1.2功能94.1.3性能94.1.4输人项104.1.5输出项104.1.6算法104.1.7流程逻辑104.1.8接口104.1.9存储分配104.1.10注释设计114.1.11限制条件114.1.12尚未解决的问题114.2程序1（标识符）设计说明115运行设计115.1运行模块组合115.2运行控制115.3运行时间126系统出错处理设计126.1出错信息126.2补救措施127系统维护设计128尚未解决的问题131 引言1.1 编写目的【给出项目系统设计说明书的编写目的，同时指明读者对象。】1.2 背景【标识要开发的软件产品（名称，代码）；列出此项目的任务提出者、开发者、用户，以及将运行该软件的计算站（中心）。】1.3 术语与缩写解释【列出本文件中用到的专门术语的定义和外文首字母缩写的原词组。】缩写、术语解 释PMO项目管理办公室，Project Management OfficePP项目策划（规划），Project Planning1.4 参考资料【提示：可包括：（1）本项目经核准的计划任务书、需求规格说明书、合同或上级机关的批文；（2）本文档所引用的资料、规范等，列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。】2 概述2.1 系统任务2.1.1 系统目标 【说明本系统将要实现的目标。】2.1.2 运行环境 【简要地说明对本系统的运行环境的规定，包括所需的硬件设备和支持软件。】2.1.3 与其它系统关系【当前系统是某一软件产品的一部分，或者与其它系统有密切关联时，说明相互间的关系。】2.2 需求规定【说明对本系统的主要的输入/输出项目、处理的功能和性能要求，以及需求说明书中明确的其它专门要求。】2.2.1 功能需求2.2.2 非功能性需求2.2.3 约束和假定【描述系统设计中最主要的约束，这些是由客户强制要求并在需求说明书写明的。说明系统是如何来适应这些约束的。 另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能辅助，那么系统可能还受到其它的约束。这种情况下，要求清楚地描述与本系统有交互的软件类型以及这样导致的约束。】3 总体设计3.1 基本设计概念和处理流程【说明本系统的基本设计概念和处理流程，尽量使用图表的形式。】3.2 软件系统结构【用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系。】3.2.1 模块A。3.2.2 模块B。3.3 功能需求与系统模块的关系本条用一张如下的矩阵图说明各项功能需求的实现同各模块的分配关系：系统模块1系统模块2系统模块m功能需求1功能需求2功能需求n3.4 子程序与功能需求、系统模块间的关系程序标识需求标识模块标识程序1（标识符）程序2（标识符）程序n（标识符）3.5 接口设计3.5.1 用户接口【说明将向用户提供的命令和它们的语法结构，以及软件的回答信息。】3.5.2 外部接口【说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。】3.5.3 内部接口【说明本系统之内的各个系统元素之间的接口的安排。】3.6 数据结构设计3.6.1 逻辑结构设计要点【给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。】3.6.2 物理结构设计要点【给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。】3.6.3 数据结构与程序的关系【说明各个数据结构与程序的关系，可采用下图形式进行说明。】程序1程序2程序m数据结构1数据结构2数据结构n4 子程序设计4.1 程序1（标识符）设计说明【从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。 对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层 模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。】4.1.1 程序描述【给出对该程序的简要描述，主要说明安排设计本程序的目的意义，说明本程序的特点。】4.1.2 功能 【说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。】4.1.3 性能【说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。】4.1.4 输人项【给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。】4.1.5 输出项【给出对每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范围，输出的形式、数量和频度，输出媒体、对输出图形及符号的说明、安全保密条件等等。】4.1.6 算法【详细说明本程序所选用的算法，写出具体的计算公式和计算步骤。】4.1.7 流程逻辑【用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。如果涉及到界面，把界面要画出来。】4.1.8 接口【用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。】4.1.9 存储分配【根据需要，说明本程序的存储分配。】4.1.10 注释设计【说明准备在本程序中安排的注释，如：a 加在模块首部的注释；b 加在各分枝点处的注释；c 对各变量的功能、范围、缺省条件等所加的注释；d 对使用的逻辑所加的注释等等。】4.1.11 限制条件【说明本程序运行中所受到的限制条件。】4.1.12 尚未解决的问题【说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。当确认在设计中无遗留问题时，此项可以去掉。】4.2 程序1（标识符）设计说明【用类似4.1的方式，说明第2个程序乃至第N个程序的设计考虑。】5 运行设计5.1 运行模块组合【说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。】5.2 运行控制【说明每一种外界的运行控制的方式方法和操作步骤。】5.3 运行时间【说明每种运行模块组合将占用各种资源的时间。】6 系统出错处理设计6.1 出错信息【用一览表的方式说明每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。】6.2 补救措施【说明故障出现后可能采取的补救措施，包括：a. 说明准备采用的后备技术，当原始系统数据万一丢失时，启用的副本的建立和启动的技术，例如，周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；b. 说明准备采用的降效技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；c. 说明将使用的恢复再启动技术，使软件从故障点