CSCI详细设计说明书模板

1、文档编号：项目名称XXXX CSCI 详细设计说明书单位名称XXXX 年 X 月修改记录版本变更原因变更内容简述编制/ 修订 者批准者发布日 期目录1 范围标识CSCI 概述文档概述2 引用的文档3 CSCI 设计CSCI 结构CSCI 运行组织CSCI 性能要求CSCI 设计限制和约束CSCI 测试计划4 CSC 设计CSC 的名称和唯一标识符下一级 CSC的名称和唯一标识符CSU 的名称和唯一标识符5 CSCI 数据说明CSCI 内部数据元素CSCI 外部接口数据元素6 CSCI 数据文件CSC 和 CSU数据文件的交叉引用 数据文件名和唯一标识符7 需求可追踪性1 范围标识【系统背景】

2、系统标识符：（系统标识符） 系统名称 ：（系统名称） 缩写 ：给出系统的缩写【适用的 CSCI】 标识符：（CSCI标识符） 名称 ：（CSCI名称） 缩写 ：给出 CSCI的缩写CSCI 概述【系统功能概述】 简要描述本系统的功能。【CSCI功能概述】（给出 CSCI在需求规格说明书中对应的需求规格标识号的引用） 。 如有必要可用图示表示本 CSCI在系统中的位置（顶层系统结构图） 文档概述【用途】CSCICSC本文档用于描述在进行 CSCI 详细设计中每个阶段的设计结果，提供 的详细设计说明书。【内容】本文档的主题内容如下：描述 CSCI的功能和作用；定义 CSCI 的结构（用一组 CSC

3、，以及这些 CSC之间的接口关系，定义 的名称，标示符，分配的需求集） ；定义 CSCI设计限制；定义 CSCI资源使用设计；定义 CSCI每个 CSC以及 CSU的详细设计。描述每个 CSC可追溯的需求规格和接口规格说明2 引用的文档 按下列格式列出本文档引用到的所有文档 【序号】 【文档编号】 【文档名称】3 （ CSCI名称）详细设计 （CSCI名称）结构3.1.1 （ CSCI名称） 详细结构 【CSC分配】 列表给出每个 CSC的分配。表 3 1 CSC分配表名称唯一标识符层级功能需求分配其中：“层级”：该 CSC被分解的级数，如果该 CSC没有子 CSC则为 1，否则为子 CSC层

4、级加 1。“需求分配”：分配给该 CSC的需求规格说明标识符。 【CSCI结构描述】描述本 CSCI的结构 CSC以及下一级 CSC之间的关系、运行时的简要流程和 在设计上的考虑等。【CSCI结构图】 用一组 CSC描述 CSCI的内部结构图：给出每个 CSC以及下一级 CSC（如果 有）和它们的接口关系（结构筐土、类图等） 。3.1.2 （ CSCI名称）内部接口 列表给出 CSCI结构中定义的所有 CSC间的接口名称，标识符，起始 CSC和 终止 CSC的接口的其他信息。表 3 2 CSC内部接口分配表名称标识 符发出者 CSC 名称接收者 CSC名称功能接口类型相关 的过 程传送的数据（

5、过（名程名）称：类 型）其中：“名称”和“标识符”：确定从“起始 CSC”到“终止 CSC”之间的接口名称 和唯一的标识符。“接口类型”：描述该接口的类型，这些类型可能是“中断” 、“过程或方法 调用”、“信号量”等。“传送的数据”：描述在该接口之间传输的数据流名称。3.1.3 （ CSCI名称）提供的外部接口与 CSC内部接口关系列表给出 CSCI结构中定义的本 CSCI于其他 CSCI间的所有接口的分配 表 3 3 CSCI 外部接口分配表名称标识 符发出者 CSCI 名称接收者 CSC名称功能接口类型相关 的过 程传送的数据（过 程名）（名 称：类 型）其中：“名称”和“标识符”：给出其

6、它 CSCI 与本 CSCI之间的一个接口的名称和唯一的标识符。 “接口类型”：描述该接口的类型，这些类型可能是“中断” 、“过程或方法 调用” 、“信号量”等。“传送的数据”：描述在该接口之间传输的数据流的名称和类型。CSCI 运行组织使用状态转换图、 活动图、顺序图或者协作图等描述软件动态结构的图示描 述 CSCI 运行时的动态结构。【CSCI状态图】同时给出 CSCI的系统状态图，在图上说明系统每个状态之间转换的条件和 数据流等信息。CSCI状态表】给出本 CSCI运行时所有的系统状态和模式以及该状态和模式下相关的CSC，并给出该状态和模式的简要的描述。表 3 4 CSCI 状态列表状态

7、号状态名称相关 CSC描述（简要描述本状态下的信息）其他刻画系统动态结构的图示或说明。CSCI 性能要求提供对于 CSCI在运行时必须满足的性能要求。例如：内存和进程时间（给 出计算单位）要求、资源占用率或响应时间等。如无要求则用“无。”代替下表。表 35 CSC内存/ 处理时间表CSC名称CSC标识符性能要求CSCI名称）设计限制和约束【限制条件】给出实现和运行本 CSCI 时出现的硬件和软件限制和条件（不包括运行平台）。【编程语言】指定使用的编程语言。【编译/ 开发环境】指定适用的编译环境（编译器、编译环境选项、编译依赖的各种类库、运行 库、模板库、其他编译单元等） 。【运行平台】指定本

8、CSCI运行时的硬件平台（计算机、通讯设备、网络设备和其他专用 设备等）和软件平台（操作系统、数据库管理系统、第三方软件产品等） 。【标准】指定实现和运行本 CSCI时采用的标准 （语言标准、 编译器标准、 编码标准、CSCI 测试计划给出 CSCI 测试用例规格的引用说明。4 CSC 详细设计从节开始编号，分小节描述每个 CSC的详细设计。 （CSC的名称和唯一标识符） 下一级 CSC的名称和唯一标识符如果有下一级 CSC划分，从节开始编号描述节描述的 CSC的下一级 CSC的详 细设计。如果无下一级 CSC划分，则略去“ y. ”，从节开始编号。【定义】给出 CSC在第三章 CSC 分配表

9、中的引用说明。 例如“参见 CSC分配表的”。 【CSC环境和接口】以图示给出本 CSC提供的所有接口过程的数据流格式和方向，以及与这些 接口关联的其他 CSC。如有必要，给出 CSC的状态转换图描述 CSC所能经历状态 和在不同状态下的行为。【CSU分配】列表给出每个 CSU的分配。表 3 6 CSU分配表名称唯一标识符功能需求分配其中：“需求分配”：与该 CSU相关的分配给 CSC的需求规格说明标识符CSC结构描述】描述本 CSC的结构和每个 CSU之间的关系、运行时的简要流程和在设计上考 虑，用到的设计模式及其解决的问题等。【CSC结构图】以一组 CSU给出本 CSC的内部结构，这些 C

10、SU为主要是对象（类） 。要求给 出这些 CSU之间的数据流和控制流信息，并给出这些 CSU引出到 CSC用于完成 CSC每个接口过程的那些接口。【运行组织】使用流程图、 活动图、协作图或者顺序图描述 CSC运行时的任务模型和运行 时刻的表示模型。【设计限制和约束】【限制条件】给出实现和运行本 CSCI时出现的硬件和软件限制和条件 （不包括运行 平台）。【编程语言】 指定使用的编程语言。【编译/ 开发环境】 指定适用的编译环境（编译器、编译环境选项、编译依赖的各种类库、 运行库、模板库、其他编译单元等） 。【CSC测试计划】给出 CSC具体的 CSC的测试用例规格（在 CSCI测试用例规格中）

11、的引用说 明。（CSU的名称和唯一标识符） 从节开始编号。分节描述每个 CSU的详细设计。 关于 CSU的设计说明参见 CSU详细设计规格编制规范 。5 （ CSCI名称）数据说明描述 CSCI的全局数据元素。CSCI名称）内部数据元素【数据元素定义】表 （ CSCI名称）全局内部数据元素定义表名标意数初度值域精精度/输入来数安称识义据始量/合确分辨方式/源量/全/符类值单法性度率输入频保型位检查媒体度密条件【数据元素结构】给出表中给出的数据类型 （除使用的程序设计语言的内部数据类型、 开发编译环 境中提供的数据类型之外） 的所有数据类型的定义和说明。 这些数据结构采用软 件 CSCI 详细设

12、计伪代码使用规范中的定义的相关规范来描述。（CSCI名称）外部接口的数据元素表外部接口的数据元素定义表名称标识符接口标识符定义位置（给出描述本数据元素的设计文档和章节编号）6 （ CSCI名称）数据文件CSC 和 CSU数据文件的交叉引用给出每个 CSCI全局数据文件在 CSC和 CSU中使用的映像关系 使用如下表所示的格式（每个数据文件占用一行） ：表 6 1 数据文件映像表文件标识符引用文件的 CSC引用文件的 CSU（文件的 唯一标识 符）（分格，每CSC）一格给出一个（分格，每一格给出在前面给出 的 CSC中的一个 CSU）数据文件名和唯一标识符）从节开始编号，分节给出表 61 中给出

13、的每个数据文件的用途、容量、访 问方式以及文件的内部数据格式等特性。【文件用途】描述文件在本 CSCI中起到的角色和和作用。【访问方式】 描述文件被访问时的方式。【位置】 给出该文件的物理位置。【安全/ 保密条件】描述文件在 CSCI中被访问时的权限设置、加密限制等。【数据容量】 给出文件的尺寸和数据容量的描述。【文件数据结构】 给出构成文件的所有数据元素的结构关系， 并给出每个数据元素的定义和说 明。这些数据结构采用软件 CSCI详细设计伪代码使用规范中的定义的相关 规范来描述。7 需求可追踪性给出 CSCI中的软件需求规格和接口需求规格在 CSC和 CSU中被分配的映像 关系（ CSU有可能部分参与这些需求规格） 。使用如下表示的格式：表 7 1 需求、接口规格映像表