《软件详细设计说明模板.docx》由会员分享,可在线阅读,更多相关《软件详细设计说明模板.docx(6页珍藏版)》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、文档代号阶段软盘编号密级(软件产品代号)(软件名称)软件详细设计说明编写校对审核会签标审批准XX内容提要:主题词更改栏更改单号更改日期更改人更改方法共6页第2页1 范围41.1标识41. 2系统概述41. 3文档概述42引用文档43 详细设计44 CSCI数据文件64. 1 CSC/CSU使用以下的交叉引用64.2 (数据文件名和工程唯一标识号)61范围1.1 标识a)已批准的标识号:封面文档代号;b)标题:软件名称+详细设计说明;c)缩略语;d)本文档适用的系统和计算机软件配置项(CSCI),并标识派生该CSCI需求的 更高层的规格说明。1.2 系统概述概述本文档所适用的系统和CSCI的用途
2、。1.3 文档概述概述本文档的用途和内容。2引用文档按文档号和标题列出本文档引用的所有文档。3 详细设计分第描述每个CSC的详细设计。从3.1条开始编号。分小条标识和描述CSC的每一个计算机软件单(CSU)o用CSU 间的控制流和数据流描述CSU间的关系。并标识CSU与外部联接的所有接口。对于那 些被多个CSC使用的CSU,应该详细地描述在一个CSC下的情况,其它的CSC只需 要引用。3.X.Y (CSU的名称和工程唯一标识号)从条开始编号。标识CSU的名称和工程唯一标识号,并指出CSU的用途, 可以再分小节提供CSU的设计信息。3.X.Y.1 (CSU的名称)的设计及约束从3.LL1条开始编
3、号。指出CSU的设计需求。标识分配给CSC的需求,这些需示 应是由CSU全部或局部满足的。另外,该条还要标识CSU设计中的所有约束条件。在 该条定义的设计需求应包括人一机接口的设计需求。3.X.Y.2 (CSU的名称)的设计从条开始编号,给出CSU的设计说明。如果CSU不是用CSCI规定语言编 写,那么要标识这一程序语言,并且阐述使用该语言的基本原理。如果CSU保存在库 中,那么各节要标识库的名称和工程唯一的标识号以及描述该库的设计文档。下面给出 CSU详细的设计信息,这些信息可以通过自动化工具或其它技术提供,例如程序设计语 共6页第4页 言、流程图或其它设计方法。a)输入/输出数据元素。标识
4、并指出每个输入/输出数据元素的用途。数据元素的 设计信息将在本文档第4章提供;b)局部数据元素。标识并指出每个在CSU中产生的并且不被其它CSU所使用的数 据元素的用途。每个数据元素可用名称、简单的描述、数据类型、数据表示、 大小、度量单位、极限值、值域、精确度、精度、分辨率以及任何其它的数据 属性。这些信息可以在CSU局部数据定义表中提供;c)中断和信号。标识和描述CSU处理的中断和信号。同时,要标识每个中断和信 号的信号源、用途、优先级、期望响应及响应时间、最小值、最大值和发生的 概率;d)算法。标识和简述CSU的功能,详细地描述CSU的执行算法。算法可以用输入 操作和局部数据元素以及产生
5、输出数据元素来描述;e)错误处理。标识和描述CSU的错误诊断和恢复特征,包括对错误的输入数据和 影响CSU执行的其它条件的处理;f) 数据转换。标识和描述为实现CSU的接口要执行的数据转换操作;g)其它元素的使用。描述CSU所使用的其它元素的用途,它包括,但不仅限于:1)其它CSU (例如:库函数调用,访问数据库的I/O服务调用、大容量存储 设备以及实时I/O通道);2)全局内存的共享存储数据(例如:数据库或数据文件、表、公用池、数据 池等等);3)输入输出缓冲,包括信息缓冲。h)逻辑流程图。根据a到g项描述CSU的逻辑流程,并描述CSU执行时初始化 的条件、调用的通信接口的特征以及其它CSU
6、控制条件。假设在CSCI的操作期 间序列是被动态的控制,那么应描述控制的方法和该方法的逻辑和输入条件,例 如时间变化、优先级赋值、诸如输入/输出、内部存储器的数据传送的内部操 作、离散输入信号的读出以及与CSCI的中断操作的时间关系;i) 数据结构。描述CSU实现的局部数据结构以及CSU所使用的所有共享数据结 构;j) 局部数据文件和数据库。如果数据文件或数据库是CSU的局部数据的一局部, 那么应指出每个数据文件或数据库的用途,并用记录、字段等术语描述该文件 或数据库的结构和访问过程(顺序的或随机的);k)局限性。描述限制CSU性能的局限性或不通用特征。4 CSCI数据文件分条描述CSCI的每个共享数据文件。4.1 CSC/CSU使用以下的交叉引用为CSC和CSU使用以下每个数据文件提供一个映象。4.2 (数据文件名和工程唯一标识号)用名称和工程唯一标识号标识被多个CSU共享的CSCI数据文件。并陈述数据文件 的用途,标识文件的最大尺寸,描述文件的访问方法,(如随机的或顺序的)。还应提供 文件中各记录的结构和大小,描述驻留在文件中的数据:数据类型、数据表示、大小、 度量单位、极限值/值域、精确度、精度/分辨率以及数据的其它属性。这些信息可用一 个文件或一张表提供。