CSCI设计说明书模板.docx

CSCI 具体设计说明书模板LT文档编号：工程名称XXXX CSCI 具体设计说明书单位名称XXXX 年 X 月修改记录版本变更缘由变更内容简述编制/修订者批准者公布日期名目1 范围1.1 标识1.2 CSCI 概述1.3 文档概述2 引用的文档3 CSCI 设计3.1 CSCI 构造3.2 CSCI 运行组织3.3 CSCI 性能要求3.4 CSCI 设计限制和约束3.5 CSCI 测试打算4 CSC 设计4.x CSC 的名称和唯一标识符4.x.y 下一级 CSC 的名称和唯一标识符4.x.y.z CSU 的名称和唯一标识符5 CSCI 数据说明5.1 CSCI 内部数据元素5.2 CSCI 外部接口数据元素6 CSCI 数据文件6.1 CSC 和 CSU 数据文件的穿插引用6.x 数据文件名和唯一标识符7 需求可追踪性1 范围1.1 标识【系统背景】系统标识符：系统标识符系统名称 ：系统名称 缩写：给出系统的缩写【适用的 CSCI】标识符：CSCI 标识符名称 ：CSCI 名称缩写 ：给出 CSCI 的缩写1.2 CSCI 概述【系统功能概述】简要描述本系统的功能。【CSCI 功能概述】给出 CSCI 在需求规格说明书中对应的需求规格标识号的引用。如有必要可用图示表示本 CSCI 在系统中的位置顶层系统构造图。1.3 文档概述【用途】本文档用于描述在进展 CSCI 具体设计中每个阶段的设计结果，供给 CSCI的具体设计说明书。【内容】本文档的主题内容如下： 描述 CSCI 的功能和作用；定义 CSCI 的构造用一组 CSC，以及这些 CSC 之间的接口关系，定义CSC 的名称，标示符，安排的需求集；定义 CSCI 设计限制；定义 CSCI 资源使用设计；定义 CSCI 每个 CSC 以及 CSU 的具体设计。描述每个 CSC 可追溯的需求规格和接口规格说明。2 引用的文档按以下格式列出本文档引用到的全部文档。【序号】 【文档编号】 【文档名称】3 CSCI 名称具体设计3.1 CSCI 名称构造3.1.1 CSCI 名称 具体构造【CSC 安排】列表给出每个 CSC 的安排。表 31 CSC 安排表名称唯一标识符层级 功能需求安排其中：“层级”：该 CSC 被分解的级数，假设该CSC 没有子 CSC 则为 1，否则为子 CSC 层级加 1。“需求安排”：安排给该 CSC 的需求规格说明标识符。【CSCI 构造描述】描述本 CSCI 的构造 CSC 以及下一级 CSC 之间的关系、运行时的简要流程和在设计上的考虑等。【CSCI 构造图】用一组 CSC 描述 CSCI 的内部构造图：给出每个 CSC 以及下一级 CSC假设有和它们的接口关系构造筐土、类图等。3.1.2 CSCI 名称内部接口列表给出 CSCI 构造中定义的全部 CSC 间的接口名称，标识符，起始CSC和终止 CSC 的接口的其他信息。表 32 CSC 内部接口安排表名称标识发出者接收者功能接口类型相关传送的符CSC名称CSC 名称的过程数据过名程名 称：类型其中：“名称”和“标识符”：确定从“起始 CSC”到“终止 CSC”之间的接口名称和唯一的标识符。“接口类型”：描述该接口的类型，这些类型可能是“中断”、“过程或方法调用”、“信号量”等。“传送的数据”：描述在该接口之间传输的数据流名称。3.1.3 CSCI 名称供给的外部接口与 CSC 内部接口关系列表给出 CSCI 构造中定义的本 CSCI 于其他 CSCI 间的全部接口的安排。表 33 CSCI 外部接口安排表名称标识符发出者CSCI名称接收者CSC 名称功能 接口类型相关的过程传送的数据过名程名 称：类型其中：“名称”和“标识符”：给出其它 CSCI 与本 CSCI 之间的一个接口的名称和唯一的标识符。“接口类型”：描述该接口的类型，这些类型可能是“中断”、“过程或方法调用” 、“信号量”等。“传送的数据”：描述在该接口之间传输的数据流的名称和类型。3.2 CSCI 运行组织使用状态转换图、活动图、挨次图或者协作图等描述软件动态构造的图示 描述 CSCI 运行时的动态构造。【CSCI 状态图】同时给出 CSCI 的系统状态图，在图上说明系统每个状态之间转换的条件和数据流等信息。【CSCI 状态表】给出本 CSCI 运行时全部的系统状态和模式以及该状态和模式下相关的CSC，并给出该状态和模式的简要的描述。表 34 CSCI 状态列表状态号 状态名称 相CSC关 描述简要描述本状态下的信息其他刻画系统动态构造的图示或说明。3.3 CSCI 性能要求供给对于 CSCI 在运行时必需满足的性能要求。例如：内存和进程时间给出计算单位要求、资源占用率或响应时间等。如无要求则用“无。”代替下表。表 35 CSC 内存/处理时间表CSC 名称CSC 标识符 性能要求3.4 CSCI 名称设计限制和约束【限制条件】给出实现和运行本 CSCI 时消灭的硬件和软件限制和条件不包括运行平台。【编程语言】指定使用的编程语言。【编译/开发环境】指定适用的编译环境编译器、编译环境选项、编译依靠的各种类库、运 行库、模板库、其他编译单元等。【运行平台】指定本 CSCI 运行时的硬件平台计算机、通讯设备、网络设备和其他专用设备等和软件平台操作系统、数据库治理系统、第三方软件产品等。【标准】指定实现和运行本 CSCI 时承受的标准语言标准、编译器标准、编码标准、通讯标准、数据格式标准、人机界面标准等。3.5 CSCI 测试打算给出 CSCI 测试用例规格的引用说明。4 CSC 具体设计从 4.1 节开头编号，分小节描述每个 CSC 的具体设计。4.x CSC 的名称和唯一标识符4.x.y 下一级 CSC 的名称和唯一标识符假设有下一级 CSC 划分，从 4.x.1 节开头编号描述 4.x 节描述的 CSC 的下一级 CSC 的具体设计。假设无下一级 CSC 划分，则略去“y.”，从 4.x 节开头编号。【定义】给出 CSC 在第三章 CSC 安排表中的引用说明。例如“参见 CSC 安排表的”。【CSC 环境和接口】以图示给出本 CSC 供给的全部接口过程的数据流格式和方向，以及与这些接口关联的其他 CSC。如有必要，给出 CSC 的状态转换图描述 CSC 所能经受状态和在不同状态下的行为。【CSU 安排】列表给出每个 CSU 的安排。表 36 CSU 安排表名称唯一标识符功能需求安排其中：“需求安排”：与该 CSU 相关的安排给 CSC 的需求规格说明标识符。【CSC 构造描述】描述本 CSC 的构造和每个 CSU 之间的关系、运行时的简要流程和在设计上考虑，用到的设计模式及其解决的问题等。【CSC 构造图】以一组 CSU 给出本 CSC 的内部构造，这些 CSU 为主要是对象类。要求给出这些 CSU 之间的数据流和把握流信息，并给出这些 CSU 引出到 CSC 用于完成 CSC 每个接口过程的那些接口。【运行组织】使用流程图、活动图、协作图或者挨次图描述 CSC 运行时的任务模型和运行时刻的表示模型。【设计限制和约束】【限制条件】给出实现和运行本 CSCI 时消灭的硬件和软件限制和条件不包括运行平台。【编程语言】指定使用的编程语言。【编译/开发环境】指定适用的编译环境编译器、编译环境选项、编译依靠的各种类 库、运行库、模板库、其他编译单元等。【CSC 测试打算】给出 CSC 具体的 CSC 的测试用例规格在 CSCI 测试用例规格中的引用说明。4.x.y.z CSU 的名称和唯一标识符从 4.x.y.1 节开头编号。分节描述每个 CSU 的具体设计。关于 CSU 的设计说明参见CSU 具体设计规格编制标准。5 CSCI 名称数据说明描述 CSCI 的全局数据元素。5.1 CSCI 名称内部数据元素【数据元素定义】表 5.1 CSCI 名称全局内部数据元素定义表附录 1 术语、缩略语给出文档正文中使用的特地术语和缩略语描述。这些描述使用如下格式：(缩略语) ：全称或意义描述。附录 X 附录名称给出在文档中提到的其他附录。