CSCI详细设计说明书模板

文档编号：
项目名称
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 标识
【系统背景】
系统标识符：（系统标识符）
系统名称：（系统名称）
缩写：给出系统的缩写
【适用的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的分配。

表3－1 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的接口的其他信息。

表3－2 CSC内部接口分配表
其中：
“名称”和“标识符”：确定从“起始CSC”到“终止CSC”之间的接口名称和唯一的标识符。

“接口类型”：描述该接口的类型，这些类型可能是“中断”、“过程或方法调用”、“信号量”等。

“传送的数据”：描述在该接口之间传输的数据流名称。

3.1.3 （CSCI名称）提供的外部接口与CSC内部接口关系
列表给出CSCI结构中定义的本CSCI于其他CSCI间的所有接口的分配。

表3－3 CSCI外部接口分配表
其中：
“名称”和“标识符”：给出其它CSCI 与本CSCI之间的一个接口的名称和唯一的标识符。

“接口类型”：描述该接口的类型，这些类型可能是“中断”、“过程或方法调用”、“信号量”等。

“传送的数据”：描述在该接口之间传输的数据流的名称和类型。

3.2 CSCI运行组织
使用状态转换图、活动图、顺序图或者协作图等描述软件动态结构的图示描述CSCI 运行时的动态结构。

【CSCI状态图】
同时给出CSCI的系统状态图，在图上说明系统每个状态之间转换的条件和数据流等信息。

【CSCI状态表】
给出本CSCI运行时所有的系统状态和模式以及该状态和模式下相关的CSC，并给出该状态和模式的简要的描述。

表3－4 CSCI状态列表
其他刻画系统动态结构的图示或说明。

3.3 CSCI 性能要求
提供对于CSCI在运行时必须满足的性能要求。

例如：内存和进程时间（给出计算单位）要求、资源占用率或响应时间等。

如无要求则用“无。

”代替下表。

表3－5 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的分配。

表3－6 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名称）全局内部数据元素定义表
【数据元素结构】
给出表5.1中给出的数据类型（除使用的程序设计语言的内部数据类型、开发编译环境中提供的数据类型之外）的所有数据类型的定义和说明。

这些数据结构采用《软件CSCI详细设计伪代码使用规范》中的定义的相关规范来描述。

5.2 （CSCI名称）外部接口的数据元素
表5.2外部接口的数据元素定义表
6 （CSCI名称）数据文件
6.1 CSC和CSU数据文件的交叉引用
给出每个CSCI全局数据文件在CSC和CSU中使用的映像关系。

使用如下表所示的格式（每个数据文件占用一行）：
表6－1 数据文件映像表
6.x（数据文件名和唯一标识符）
从6.2节开始编号，分节给出表6－1中给出的每个数据文件的用途、容量、访问方式以及文件的内部数据格式等特性。

【文件用途】
描述文件在本CSCI中起到的角色和和作用。

【访问方式】
描述文件被访问时的方式。

【位置】
给出该文件的物理位置。

【安全/保密条件】
描述文件在CSCI中被访问时的权限设置、加密限制等。

【数据容量】
给出文件的尺寸和数据容量的描述。

【文件数据结构】
给出构成文件的所有数据元素的结构关系，并给出每个数据元素的定义和说明。

这些数据结构采用《软件CSCI详细设计伪代码使用规范》中的定义的相关规范来描述。

7 需求可追踪性
给出CSCI中的软件需求规格和接口需求规格在CSC和CSU中被分配的映像关系（CSU有可能部分参与这些需求规格）。

使用如下表示的格式：
表7－1 需求、接口规格映像表
附录
附录给出了为便于理解前面的正文而需要特别说明的部分。

附录1 术语、缩略语
给出文档正文中使用的专门术语和缩略语描述。

这些描述使用如下格式：
(缩略语) ：（全称或意义描述）。

附录X （附录名称）
给出在文档中提到的其他附录。