详细需求设计说明书模板

合集下载

CSCI详细设计说明书模板

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.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的分配。

详细设计说明书模板

详细设计说明书模板

标准文件修改页文件编号修改条款 修改内容修改人/日期生效日期全文首次发行分发部门会签详细设计说明书模板文件编号版木 A0 贞数第1页共6贞編制部门 XX 部生效日期2019年10月15日编制审核批准□业务部 □研发部 □采购部 □生产部 □质量部 □行政部标准文件修订历史记录曽加•修订删除【模板使用必读:模板内容和页眉中【】包含内容为指导性的待替换文字,请在使用中替换为具体内容, 或删除。

文件提交时不得再含有这些内容J详细设计说明书模板引言L2 L3 L4编写目的 ..... 背景 ......... 术语打缩写解释参考资料 .....模块命名规则程序系统的组织结构3. 13.2 3.3程序1 4. 1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.94. 104. 114. 12子系统划分 ...................... 模块划分.........................程序与功能需求、系统模块间的关系(标识符)设计说明................ 程序描述 .....功能 .........性能 .........输人项 .......输出项 .......算法 .........流程逻辑 .....接口 .........存储分配 .....注释设讣 .....限制条件 .....尚未解决的问题程序2 (标识符)设计说明4 4 4 45 5 5 5 56 6 6 6 6 6 67 7 7 7 7引言编写目的【给出项U详细设il•说明书的编写U的,同时指明读者对象。

】背景【说明:a.待开发软件系统的名称: b•本项U的任务提出者、开发者、用户和运行该程序系统的计算中心。

】术语与缩写解释【列出本文件中用到的专门术语的定义和外文首字母缩写的原词组J参考资料【提示:可包括:<1)本项11经核准的计划任务书、需求规格说明书、合同、项U设计概要说明书或上级机关的批文;(2)本文档所引用的资料、规范等,列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。

详细设计说明书模板

详细设计说明书模板

文档编号:____________保密级别:____________ XXX详细设计说明书所属项目:文件类别:版本号:编写者:审核者:批准者:修订记录目录1引言 (4)1.1编写目的 (4)1.2背景 (4)1.3参考资料 (4)1。

4术语定义及说明 (4)2设计概述 (4)2.1任务和目标 (4)2。

2需求概述 (5)2.3运行环境概述 (5)2.4条件与限制 (5)2。

5详细设计方法和工具 (5)3系统详细需求分析 (5)3.1详细需求分析 (5)3。

2详细系统运行环境及限制条件分析接口需求分析 (5)4总体方案确认 (6)4。

1系统总体结构确认 (6)4。

2系统详细界面划分 (6)4.2。

1应用系统与支撑系统的详细界面划分 (6)4.2。

2系统内部详细界面划分 (6)5系统详细设计 (6)5。

1系统结构设计及子系统划分 (6)5.2系统功能模块详细设计 (7)5。

3系统界面详细设计 (7)5.3。

1外部界面设计 (7)5.3。

2内部界面设计 (7)5.3.3用户界面设计 (8)6数据库系统设计 (8)6。

1设计要求 (8)6.2信息模型设计 (8)6。

3数据库设计 (8)6.3.1设计依据 (8)6.3。

2数据库种类及特点 (8)6。

3。

3数据库逻辑结构 (8)6.3.4物理结构设计 (8)6.3。

5数据库安全 (9)6。

3。

6数据字典 (9)7信息编码设计 (9)7.1代码结构设计 (9)7。

2代码编制 (9)1引言1.1编写目的说明编写详细设计方案的主要目的。

说明书编制的目的是说明一个软件系统各个层次中的每个程序(每个模块或子程序)和数据库系统的设计考虑,为程序员编码提供依据。

如果一个软件系统比较简单,层次很少,本文件可以不单独编写,和概要设计说明书中不重复部分合并编写。

方案重点是模块的执行流程和数据库系统详细设计的描述。

1.2背景应包含以下几个方面的内容:A. 待开发软件系统名称;B. 该系统基本概念, 如该系统的类型、从属地位等;C. 开发项目组名称。

详细设计说明书(仅用于学习的参考模板)

详细设计说明书(仅用于学习的参考模板)

付高钢村医药管理系统项目详细设计说明书1引言1.1编写目的本说明书是医药管理系统的详细设计。

其编写目的是在概要设计的基础上,针对该项目的每个模块,每个功能的实现方法进行详细的设计和划分,按照详细设计说明书的要求,进一步明确系统结构,为项目开发人员后期的编码工作做准备。

本文档的预期的读者是:项目开发人员项目经理项目测试人员1.2背景在前一阶段的概要设计文档中,已经通过顺序图解决了该系统功能的实现流程,包括系统的各模块间的关系设计等。

本文档就是在前一阶段成果的基础上,继续对系统的各模块进行详细的划分和说明。

2概述本项目的任务提出者:见概要设计文档单位:见概要设计文档开发者:见概要设计文档用户:见概要设计文档实现该软件的计算中心或计算机网络:见概要设计文档2.1基线以需求分析和概要设计为基准。

2.2范围本概要设计文档提供给系统设计开发人员,包括详细设计人员和项目组成员。

2.3定义2.4参考资料2.5术语与缩写解释3模块命名规则驼峰标识,由单词的全拼组成,除首单词外每个单词的首字母大写,例如:medcineManager4模块汇总4.1模块汇总表提示:这里模块是指相对独立的软件设计单元,例如对象类、函数包等等。

5子系统模块设计5.1类别管理模块5.1.1功能描述用户登录进入类别管理页面,能进行药品类别的管理,主要包括类别的添加,修改,查看和统计。

5.1.2相关模块5.1.3类图5.1.4类别管理类5.1.4.1方法5.1.4.1.1方法—药品信息的添加:public String add()5.1.4.1.1.1功能对药品的类别信息进行添加,类别编码是类别对象的一个标示,当添加一个类别信息时,需要判断此类别是否已经在数据库中,如果存在,则提示已存在该类别。

5.1.4.1.1.2参数无5.1.4.1.1.3算法无5.1.4.1.2方法—类别信息的模糊查询:public String queryallcategory()5.1.4.1.2.1功能为了方便用户查询已有类别,类别信息管理模块提供了类别模糊查询。

CSCI详细设计说明书模板

CSCI详细设计说明书模板
其它刻画系统动态结构的图示或说明。
3.3 CSCI 性能要求
提供对于CSCI在运行时必须满足的性能要求。例如:内存和进程时间(给出计算单位)要求、资源占用率或响应时间等。
如无要求则用“无。”代替下表。
表3-5 CSC内存/处理时间表
CSC名称
CSC标识符
性能要求
3.4 (CSCI名称)设计限制和约束
【CSCI结构描述】
描述本CSCI的结构CSC以及下一级CSC之间的关系、运行时的简要流程和在设计上的考虑等。
【CSCI结构图】
用一组CSC描述CSCI的内部结构图:给出每个CSC以及下一级CSC(如果有)和它们的接口关系(结构筐土、类图等)。
3.1.2(CSCI名称)内部接口
列表给出CSCI结构中定义的所有CSC间的接口名称,标识符,起始CSC和终止CSC的接口的其它信息。
3 (CSCI名称)详细设计
3.1 (CSCI名称)结构
3.1.1(CSCI名称) 详细结构
【CSC分配】
列表给出每个 CSC的分配。
表3-1 CSC分配表
名称
唯一标识符
层级
功能
需求分配
其中:
“层级”:该CSC被分解的级数,如果该CSC没有子CSC则为1,否则为子CSC层级加1。
“需求分配”:分配给该CSC的需求规格说明标识符。
表3-2 CSC内部接口分配表
名称
标识符
发出者CSC
名称
接收者CSC名称
功能
接口类型
相关的过程
传送的数据
(过程名)
(名称:类型)
其中:
“名称”和“标识符”:确定从“起始CSC”到“终止CSC”之间的接口名称和唯一的标识符。

CSCI详细设计说明书模板

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的名称和唯一标识符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。

详细需求设计说明书模板

详细需求设计说明书模板

功能设计报告1.1 编写目的 (3)1.2 背景 (3)1.3 名词定义 (3)1.3.1 公用名词 (3)1.3.2 专有名词 (3)2 总体设计 (3)2.1 需求设计 (3)2.1.1 主界面 (3)2.1.2 功能描述 (3)2.1.4 控制规则 (4)2.6 基本设计概念和处理流程(协同流) (4)2.7 结构(页面流) (4)2.8 业务流程 (4)3 接口设计 (4)3.1 档案外部接口 (4)3.2 档案内部接口 (4)3.2.1 功能窗口调用 (4)3.2.2 数据调用 (4)4 运行设计 (5)4.1 运行控制 (5)4.2 运行时间 (5)5 主要业务逻辑设计(逻辑流) (5)5.1 逻辑结构设计要点 (5)5.2 数据结构与程序的关系 (7)6 系统出错处理设计 (7)6.1 出错信息 (7)6.2 补救措施 (8)6.3 系统维护设计 (8)测试设计说明书1 引言1.1 编写目的1) 方便设计人员了解软件的具体功能;2) 规范开发过程,实现有据可查;3) 实现需求。

1.2 背景1.3 名词定义1.3.1 公用名词参见文档《名词定义》1.3.2 专有名词2 总体设计2.1 需求设计2.1.1主界面2.1.2 功能描述2.1.3 业务规则2.1.4 控制规则2.6 基本设计概念和处理流程(协同流)说明本系统的基本设计概念和处理流程,使用图表的形式。

2.7 结构(页面流)用一览表及框图的形式说明本系统的系统元素(各层模块、子程序、公用程序等)的划分,扼要说明每个系统元素的标识符和功能,分层次地给出各元素之间的控制与被控制关系.2.8 业务流程说明本系统功能处理流程,使用图表的形式。

3 接口设计3.1 档案外部接口3.2 档案内部接口3.2.1 功能窗口调用无3.2.2 数据调用可以在报表中被查询。

4运行设计4.1运行控制4.2运行时间说明每种运行模块组合将占用各种资源的时间。

CSCI详细设计说明书模板.doc

CSCI详细设计说明书模板.doc
分配表
以图示给出本CSC提供的所有接口过程的数据流格式和方向, 以及与这些接口关联的其他CSC。如有必要,给出CSC的状态转换图描述CSC所能经历状
态和在不同状态下的行为。
【CSU分配】
列表给出每个CSU的分配。
表3-6 CSU分配表
名称唯一标识符功能需求分配
其中:
“需求分配”:与该CSU相关的分配给CSC的需求规格说明标识符。
如无要求则用“无。 ”代替下表。
表3-5 CSC内存/处理时间表
CSC名称CSC标识符性能要求
3.4(CSCI名称)设计限制和约束
【限制条件】
给出实现和运行本CSCI时出现的硬件和软件限制和条件(不包括运行平台)。
【编程语言】
指定使用的编程语言。
【编译/开发环境】
指定适用的编译环境(编译器、编译环境选项、编译依赖的各种类库、运行库、模板库、其他编译单元等) 。
定义CSCI设计限制;
定义CSCI资源使用设计;
定义CSCI每个CSC以及CSU的详细设计。
描述每个CSC可追溯的需求规格和接口规格说明。
2引用的文档
按下列格式列出本文档引用到的所有文档。【序号】 【文档编号】 【文档名称】
3(CSCI名称)详细设计
3.1(CSCI名称)结构
3.1.1(CSCI名称)详细结构
4 CSC详细设计
从4.1节开始编号,分小节描述每个CSC的详细设计。
4.x(CSC的名称和唯一标识符)
4.x.y下一级CSC的名称和唯一标识符
如果无下一级CSC划分,则略去“y.”,从4.x节开始编号。
【定义】
给出CSC在第三章CSC分配表中的引用说明。例如“参见
的 ”。
【CSC环境和接口】
  1. 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。

功能设计报告文档更新记录
1引言 (3)
1.1编写目的 (3)
1.2背景 (3)
1.3名词定义 (3)
1.3.1 公用名词 (3)
1.3.2 专有名词 (3)
2总体设计 (3)
2.1需求设计 (3)
2.1.1主界面 (3)
2.1.2 功能描述 (3)
2.1.4 控制规则 (4)
2.6基本设计概念和处理流程(协同流) (4)
2.7结构(页面流) (4)
2.8业务流程 (4)
3接口设计 (4)
3.1档案外部接口 (4)
3.2档案内部接口 (4)
3.2.1 功能窗口调用 (4)
3.2.2 数据调用 (4)
4运行设计 (5)
4.1运行控制 (5)
4.2运行时间 (5)
5 主要业务逻辑设计(逻辑流) (5)
5.1逻辑结构设计要点 (5)
5.2数据结构与程序的关系 (7)
6系统出错处理设计 (7)
6.1出错信息 (7)
6.2补救措施 (8)
6.3系统维护设计 (8)
测试设计说明书1引言
1.1编写目的
1)方便设计人员了解软件的具体功能;
2)规范开发过程,实现有据可查;
3)实现需求。

1.2背景
1.3名词定义
1.3.1 公用名词
参见文档《名词定义》
1.3.2 专有名词
2总体设计
2.1需求设计
2.1.1主界面
2.1.2 功能描述
2.1.3 业务规则
2.1.4 控制规则
2.6基本设计概念和处理流程(协同流)
说明本系统的基本设计概念和处理流程,使用图表的形式。

2.7结构(页面流)
用一览表及框图的形式说明本系统的系统元素(各层模块、子程序、公用程序等)的划分,扼要说明每个系统元素的标识符和功能,分层次地给出各元素之间的控制与被控制关系.
2.8业务流程
说明本系统功能处理流程,使用图表的形式。

3接口设计
3.1档案外部接口
3.2档案内部接口
3.2.1 功能窗口调用

3.2.2 数据调用
可以在报表中被查询。

4运行设计
4.1运行控制
说明每一种外界的运行控制的方式方法和操作步骤。

4.2运行时间
说明每种运行模块组合将占用各种资源的时间。

5 主要业务逻辑设计(逻辑流)
5.1逻辑结构设计要点
给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。

5.2数据结构与程序的关系
说明各个数据结构与访问这些数据结构的形式:
6系统出错处理设计
6.1出错信息
用一览表的方式说明每种可能的出错或故障情况出现时,系统输出信息的形式、含义及处理方法。

6.2补救措施
说明故障出现后可能采取的变通措施,包括:
a.后备技术说明准备采用的后备技术,当原始系统数据万一丢失时启用的副本的建立
和启动的技术,例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术;
b.降效技术说明准备采用的后备技术,使用另一个效率稍低的系统或方法来求得所需
结果的某些部分,例如一个自动系统的降效技术可以是手工操作和数据的人工记录;
c.恢复及再启动技术说明将使用的恢复再启动技术,使软件从故障点恢复执行或使软
件从头开始重新运行的方法。

6.3系统维护设计
说明为了系统维护的方便而在程序内部设计中作出的安排,包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。

各个程序之间的对应关系,可采用如下的矩阵图的形式。

附件1 打印模板
附件2输出模板
附件3 导出模板
附件4导入模板。

相关文档
最新文档