CMMI-系统设计说明书模板.docx

广东技术股份有限公司项目名称系统设计说明书文件编号项目编号文件状态草稿正式发布正在修改当前版本拟制日期审核日期批准日期广东技术股份有限公司广东技术股份有限公司修订历史记录增加修订删除变更版本号日期变更类型修改人摘要备注模板使用必读模板内容和页眉中包含内容为指导性的待替换文字请在使用中替换为具体内容或删除文件提交时不得再含有这些内容广东技术股份有限公司目录引言编写目的背景术语与缩写解释参考资料概述系统任务系统目标运行环境与其它系统关系需求规定功能需求非功能性需求约束和假定总体设计基本设计概念和处理流程软件系统结构模块模块功能需求与系统模块的关系子程序与功能需求系统模块间的关系接口设计用户接口外部接口内部接口数据结构设计逻辑结构设计要点物理结构设计要点数据结构与程序的关系子程序设计程序标识符设计说明程序描述功能性能输人项输出项算法流程逻辑接口存储分配注释设计广东技术股份有限公司限制条件尚未解决的问题程序标识符设计说明运行设计运行模块组合运行控制运行时间系统出错处理设计出错信息补救措施系统维护设计尚未解决的问题广东技术股份有限公司引言编写目的给出项目系统设计说明书的编写目的同时指明读者对象背景标识要开发的软件产品名称代码列出此项目的任务提出者开发者用户以及将运行该软件的计算站中心术语与缩写解释列出本文件中用到的专门术语的定义和外文首字母缩写的原词组缩写术语解释项目管理办公室项目策划规划参考资料提示可包括本项目经核准的计划任务书需求规格说明书合同或上级机关的批文本文档所引用的资料规范等列出这些资料的作者标题编号发表日期出版单位或资料来源广东技术股份有限公司概述系统任务系统目标说明本系统将要实现的目标运行环境简要地说明对本系统的运行环境的规定包括所需的硬件设备和支持软件与其它系统关系当前系统是某一软件产品的一部分或者与其它系统有密切关联时说明相互间的关系需求规定说明对本系统的主要的输入输出项目处理的功能和性能要求以及需求说明书中明确的其它专门要求功能需求非功能性需求约束和假定描述系统设计中最主要的约束这些是由客户强制要求并在需求说明书写明的说明系统是如何来适应这些约束的另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功广东技术股份有限公司能辅助那么系统可能还受到其它的约束这种情况下要求清楚地描述与本系统有交互的软件类型以及这样导致的约束总体设计基本设计概念和处理流程说明本系统的基本设计概念和处理流程尽量使用图表的形式软件系统结构用一览表及框图的形式说明本系统的系统元素各层模块子程序公用程序等的划分扼要说明每个系统元素的标识符和功能分层次地给出各元素之间的控制与被控制关系模块模块功能需求与系统模块的关系本条用一张如下的矩阵图说明各项功能需求的实现同各模块的分配关系系统模块系统模块系统模块功能需求功能需求功能需求子程序与功能需求系统模块间的关系程序标识需求标识模块标识程序标识符广东技术股份有限公司程序标识符程序标识符接口设计用户接口说明将向用户提供的命令和它们的语法结构以及软件的回答信息外部接口说明本系统同外界的所有接口的安排包括软件与硬件之间的接口本系统与各支持软件之间的接口关系内部接口说明本系统之内的各个系统元素之间的接口的安排数据结构设计逻辑结构设计要点给出本系统内所使用的每个数据结构的名称标识符以及它们之中每个数据项记录文卷和系的标识定义长度及它们之间的层次的或表格的相互关系物理结构设计要点给出本系统内所使用的每个数据结构中的每个数据项的存储要求访问方法存取单位存取的物理关系索引设备存储区域设计考虑和保密条件广东技术股份有限公司数据结构与程序的关系说明各个数据结构与程序的关系可采用下图形式进行说明程序程序程序数据结构数据结构数据结构子程序设计程序标识符设计说明从本章开始逐个地给出各个层次中的每个程序的设计考虑以下给出的提纲是针对一般情况的对于一个具体的模块尤其是层次比较低的模块或子程序其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同在这种情况下只要简单地说明这一点即可程序描述给出对该程序的简要描述主要说明安排设计本程序的目的意义说明本程序的特点功能说明该程序应具有的功能可采用图即输入一处理一输出图的形式性能说明对该程序的全部性能要求包括对精度灵活性和时间特性的要求广东技术股份有限公司输人项给出对每一个输入项的特性包括名称标识数据的类型和格式数据值的有效范围输入的方式数量和频度输入媒体输入数据的来源和安全保密条件等等输出项给出对每一个输出项的特性包括名称标识数据的类型和格式数据值的有效范围输出的形式数量和频度输出媒体对输出图形及符号的说明安全保密条件等等算法详细说明本程序所选用的算法写出具体的计算公式和计算步骤流程逻辑用图表例如流程图判定表等辅以必要的说明来表示本程序的逻辑流程如果涉及到界面把界面要画出来接口用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块子程序说明参数赋值和调用方式说明与本程序相直接关联的数据结构数据库数据文卷存储分配根据需要说明本程序的存储分配广东技术股份有限公司注释设计说明准备在本程序中安排的注释如加在模块首部的注释加在各分枝点处的注释对各变量的功能范围缺省条件等所加的注释对使用的逻辑所加的注释等等限制条件说明本程序运行中所受到的限制条件尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题当确认在设计中无遗留问题时此项可以去掉程序标识符设计说明用类似的方式说明第个程序乃至第个程序的设计考虑运行设计运行模块组合说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合说明每种运行所历经的内部模块和支持软件运行控制说明每一种外界的运行控制的方式方法和操作步骤广东技术股份有限公司运行时间说明每种运行模块组合将占用各种资源的时间系统出错处理设计出错信息用一览表的方式说明每种可能的出错或故障情况出现时系统输出信息的形式含意及处理方法补救措施说明故障出现后可能采取的补救措施包括说明准备采用的后备技术当原始系统数据万一丢失时启用的副本的建立和启动的技术例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术说明准备采用的降效技术使用另一个效率稍低的系统或方法来求得所需结果的某些部分例如一个自动系统的降效技术可以是手工操作和数据的人工记录说明将使用的恢复再启动技术使软件从故障点恢复执行或使软件从头开始重新运行的方法系统维护设计说明为了系统维护的方便而在程序内部设计中做出的安排包括在程序中专门安排用于系统的检查与维护的检测点和专用模块广东技术股份有限公司尚未解决的问题说明在概要设计过程中尚未解决的而设计者认为在系统完成之前必须解决的各种问题当在概要设计中无遗留问题时此项可以去掉