CSCI详细设计项目说明指导书模板.doc

文档编号：

项目名称

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分配。
表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名称
功效
接口类型
相关过程
传送数据

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

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

（简明描述本状态下信息）
其它刻画系统动态结构图示或说明。
3.3 CSCI 性能要求
提供对于CSCI在运行时必需满足性能要求。比如：内存和进程时间（给出计算单位）要求、资源占用率或响应时间等。
如无要求则用“无。”替换下表。
表3－5 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分配。
表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 数据文件映像表
文件标识符
引用文件CSC
引用文件CSU
（文件唯一标识符）
（分格，每一格给出一个CSC）
（分格，每一格给出在前面给出CSC中一个CSU）

6.x（数据文件名和唯一标识符）
从6.2节开始编号，分节给出表6－1中给出每个数据文件用途、容量、访问方法和文件内部数据格式等特征。
【文件用途】
描述文件在本CSCI中起到角色和和作用。
【访问方法】
描述文件被访问时方法。
【位置】
给出该文件物理位置。
【安全/保密条件】
描述文件在CSCI中被访问时权限设置、加密限制等。
【数据容量】
给出文件尺寸和数据容量描述。
【文件数据结构】
给出组成文件全部数据元素结构关系，并给出每个数据元素定义和说明。
这些数据结构采取《软件CSCI具体设计伪代码使用规范》中定义相关规范来描述。

7 需求可追踪性
给出CSCI中软件需求规格和接口需求规格在CSC和CSU中被分配映像关系（CSU有可能部分参与这些需求规格）。
使用以下表示格式：
表7－1 需求、接口规格映像表
规格标识符
分配CSC
分配CSU
（需求规格唯一标识符）
（分配给前面规格全部CSC）
（给出在前面一组CSC中全部CSU，CSU全部和前面需求规格相关）
附录
附录给出了为便于了解前面正文而需要尤其说明部分。
附录1 术语、缩略语
给出文档正文中使用专门术语和缩略语描述。
这些描述使用以下格式：
(缩略语) ：（全称或意义描述）。
附录X （附录名称）
给出在文档中提到其它附录。