CSCI详细设计说明书模板

《CSCI详细设计说明书模板》由会员分享，可在线阅读，更多相关《CSCI详细设计说明书模板（16页珍藏版）》请在金锄头文库上搜索。

1、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 外部接口数据

2、元素6 CSCI 数据文件6.1 CSC 和 CSU 数据文件的交叉引用6.x 数据文件名和唯一标识符7 需求可追踪性1 范围1.1 标识【系统背景】 系统标识符：（系统标识符） 系统名称 ：（系统名称） 缩写 ：给出系统的缩写 【适用的 CSCI】标识符：（CSCI标识符）名称 ：（ CSCI 名称）缩写 ：给出 CSCI 的缩写1.2 CSCI 概述【系统功能概述】 简要描述本系统的功能。【CSCI 功能概述】（给出 CSCI 在需求规格说明书中对应的需求规格标识号的引 用）。如有必要可用图示表示本 CSCI 在系统中的位置（顶层系统 结构图）。1.3 文档概述【用途】本文档用于描述在进行

3、 CSCI 详细设计中每个阶段的设计结果，提供CSCI的详细设计说明书。【内容】本文档的主题内容如下：描述 CSCI 的功能和作用；定义CSCI的结构（用一组CSC,以及这些CSC之间的接口关系，定义 CSC 的名称，标示符，分配的需求集）；定义 CSCI 设计限制；定义 CSCI 资源使用设计；定义 CSCI 每个 CSC 以及 CSU 的详细设计。描述每个 CSC 可追溯的需求规格和接口规格说明。2 引用的文档按下列格式列出本文档引用到的所有文档。【序号】 【文档编号】 【文档名称】3 （ CSCI 名称）详细设计3.1 （CSCI 名称）结构3.1.1 （CSCI 名称） 详细结构【CS

4、C 分配】列表给出每个 CSC 的分配。表 31 CSC 分配表名称唯标识符层级功能需求分配其中：“层级”：该 CSC 被分解的级数,如果该 CSC 没有子 CSC 则 为 1,否则为子 CSC 层级加 1。“需求分配”：分配给该 CSC 的需求规格说明标识符。【CSCI 结构描述】描述本 CSCI 的结构 CSC 以及下一级 CSC 之间的关系、运行时的 简要流程和在设计上的考虑等。【CSCI 结构图】用一组 CSC 描述 CSCI 的内部结构图：给出每个 CSC 以及下一级 CSC （如果有）和它们的接口关系（结构筐土、类图等）。3.1.2 （CSCI 名称）内部接口列表给出 CSCI 结

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

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

7、【CSCI 状态表】给出本 CSCI 运行时所有的系统状态和模式以及该状态和模式下相关的CSC，并给出该状态和模式的简要的描述。表 34 CSCI 状态列表状态号状态名称相 关CSC描述（简要描述本状态下的信息）其它刻画系统动态结构的图示或说明。3.3 CSCI 性能要求提供对于 CSCI 在运行时必须满足的性能要求。例如：内存和进程时间（给出计算单位）要求、资源占用率或响应时间等。如无要求则用“无。”代替下表。表 35 CSC 内存/处理时间表CSC名称CSC标识符性能要求3.4（CSCI 名称）设计限制和约束【限制条件】给出实现和运行本 CSCI 时出现的硬件和软件限制和条件（不包 括运行

8、平台）。【编程语言】指定使用的编程语言。【编译/开发环境】指定适用的编译环境（编译器、编译环境选项、编译依赖的各 种类库、运行库、模板库、其它编译单元等）。【运行平台】指定本 CSCI 运行时的硬件平台（计算机、通讯设备、网络设备 和其它专用设备等）和软件平台（操作系统、数据库管理系统、 第三方软件产品等）。【标准】指定实现和运行本 CSCI 时采用的标准（语言标准、编译器标 准、编码标准、通讯标准、数据格式标准、人机界面标准等）。 3.5 CSCI 测试计划给出CSCI测试用例规格的引用说明。4 CSC详细设计从 4.1 节开始编号，分小节描述每个 CSC 的详细设计。4.x（CSC 的名称

9、和唯一标识符）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 分配表名称唯标识符功能需

10、求分配其中：“需求分配”：与该 CSU 相关的分配给 CSC 的需求规格说明 标识符。【CSC 结构描述】描述本 CSC 的结构和每个 CSU 之间的关系、运行时的简要流程 和在设计上考虑，用到的设计模式及其解决的问题等。【CSC 结构图】以一组 CSU 给出本 CSC 的内部结构，这些 CSU 为主要是对象 （类）。要求给出这些 CSU 之间的数据流和控制流信息，并给出 这些CSU引出到CSC用于完成CSC每个接口过程的那些接口。【运行组织】使用流程图、活动图、协作图或者顺序图描述 CSC 运行时的任 务模型和运行时刻的表示模型。【设计限制和约束】【限制条件】给出实现和运行本 CSCI 时出

11、现的硬件和软件限制和条件不包括运行平台）。【编程语言】 指定使用的编程语言。【编译/开发环境】指定适用的编译环境（编译器、编译环境选项、编译依赖的各种类库、运行库、模板库、其它编译单元等）。【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

12、 名称）全局内部数据元素定义表名 称标识符意义数据 类 型初始值度 量 单 位值域/ 合法 性检 查精确度精度/ 分辨 率输入 方式/ 输入 媒体来源数量/频度安 全/ 保 密 条 件数据元素结构】 给出表 5.1 中给出的数据类型（除使用的程序设计语言的内部数 据类型、开发编译环境中提供的数据类型之外）的所有数据类型 的定义和说明。这些数据结构采用软件 CSCI 详细设计伪代码使 用规范中的定义的相关规范来描述。5.2 （CSCI 名称）外部接口的数据元素表 5.2 外部接口的数据元素定义表名称标识符接口标识符定义位置（给出扌田述本数据兀素的设计文档和早节编号）6 （ CSCI 名称）数据文

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