软件文档模板-软件详细设计说明.docx

《软件文档模板-软件详细设计说明.docx》由会员分享，可在线阅读，更多相关《软件文档模板-软件详细设计说明.docx（14页珍藏版）》请在得力文库 - 分享文档赚钱的网站上搜索。

1、（产品名称）软件详细设计说明（宋体小初）XX公司二OXX年XX月（宋体三号）XXXX软件详细设计说明4. 1.3 CSCI 类图4.1.3.1类包名称顺序进行编号，对每个类包的类图进行说明。4. 1.3. 1. 1类图名称顺序进行编号，画出该类包的所有类图。4. 1.3. 1.2类说明对该类包下的所有类进行说明。表5类说明注1：实现的程序名称指编程时实现该类的源程序名称。类名称用途开发状态/类型实现的程序 名称备注注2：假设适用，备注可指出每个软件单元(类)所使用的计算机硬件资源。4.2执行概念本节描述软件单元间的执行概念。应包含表示软件单元之间动态关系的图示和说 明,即CSCI操作期间它们如

2、何交互。4. 2. 1 CSCI活动图如存在的话，画出CSCI设计中的所有活动图并配以文字说明，如有多个图形可分 小节分别描述。否那么本节可省略。4.2.2 CSCI交互图如存在的话，画出CSCI设计中的所有交互图并配以文字说明，如有多个图形可分 小节分别描述。否那么本节可省略。4.2.3 CSCI状态图如存在的话，画出CSCI设计中的所有状态图并配以文字说明，如有多个图形可分 小节分别描述。否那么本节可省略。4. 2.4 CSCI进程图如有可能，画出CSCI设计中的部件执行图(Component View)来反映CSCI进程间 的调度关系并配以文字说明各进程的激发结束等条件，如有多个图形可分

3、小节分别描 述。否那么本节可省略。义X X义软件详细设计说明4. 2. 5其它动态行为设计如需要，用文字或其它方法来描述CSCI的其它动态行为。4. 3接口设计本节描述软件单元的接口特性，既包括软件单元之间的内部接口，也包括与外部实 体，如系统、配置项、用户之间的接口；只描述对软件需求规格说明（SRS）中的接口需 求局部做出修改或增加的接口，其余相同的局部可在此引用；如果本节局部内容已在接 口设计说明（IDD）中给出，那么在此引用不必具体描述。如接口设计说明中没有提供，那 么一定要在此处给出。4. 3. 1外部接口设计外部接口示意图CSCI的外部接口将CSCI作为一个整体来考虑，即描述和与它共

4、享数据、向它提供 数据或与它交换数据的外部实体的关系。在Rose中，接口设计示意图可通过在Logical View下的类图来表示。外部接口描述4. 3. 1.2. 1外部接口标识表6外部接口标识接口名称工程唯一 标识符需求描述接口类 型接口优先 级别发送方名称/标识符接收方名 称/标识符注1： “接口类型”：如实时数据传送、数据的存储和检索等。注2： “发送方”、“接收方”：指CSCI、用户等接口实体。通信方法特性描述接口实体为外部接口使用的通信方法的特性。如接口实体对接口通信特性没有 专门要求，本节可省略。如果所有外部接口使用的通信方法是统一的，那么在此处描述。 在以下各接口的详细描述中就不

5、再重复有关内容；如果各外部接口使用的通信方法是不 同的，那么应在以下各接口的详细描述中用类似下表的格式分别描述，而本节可省略。下表仅供用户参考，用户可根据实际情况对要说明的内容添加或删除，也可自己设 计表格或用文字描述。表7外部接口的通信方法特性通信方法 名称工程唯一标 识符通信链路/带宽/频率特性数据传送特性其它特性5XXXX软件详细设计说明通信方法 名称工程唯一标 识符通信链路/带宽/频率特性数据传送特性其它特性注1:数据传送特性，包括传送速率、周期或非周期以及传送间隔。注2：其它特性，可包括：传输服务，包括：优先级别和等级；平安性/保密性/私密性方面的 考虑，如：加密、用户鉴别、隔离、审

6、计等；流控制（如：序列编号和缓冲区分配）；消息格式化； 路由、寻址、命名约定等内容。协议特性描述接口实体为外部接口使用的协议方法的特性。如接口实体对接口协议特性没有 专门要求，本节可省略。如果所有外部接口使用的协议方法是统一的，那么在此处描述。 在以下各接口的详细描述中就不再重复有关内容；如果各外部接口使用的协议方法是不 同的，那么应在以下各接口的详细描述中用类似下表的格式分别描述，而本节可省略。下表仅供用户参考，用户可根据实际情况对要说明的内容添加或删除，也可自己设 计表格或用文字描述。表8外部接口的协议特性注1：分组，包括：分段和重组、路由、寻址。协议方法 名称工程唯一 标识符优先级/层分

7、组同步其它特性注2：同步，包括：连接的建立、维护、终止。注3：其它特性，可包括：合法性检查、错误控制和恢复过程；状态、标识、任何其它的报告特征等内容。外部接口名称/工程唯一标识符对所有外部接口分小节进行说明，在标题处填上各外部接口的名称或标识符。下表仅供用户参考，用户可根据实际情况对要说明的内容添加或删除，也可自己设 计表格或用文字描述。4. 3. 1.3. 1数据元素特性描述接口实体必须提供、存储、发送、访问、接收的单个数据元素的特性。表9数据元素特性6序名称工程唯一 标识符数据 类型大小和格 式/单位范围/ 枚举准确性/ 精度其它特性说明XXXX软件详细设计说明注1: “序号”：对数据元素

8、从1开始进行编号。注2： “数据类型”：指字母数字、字符、整数等。注3： “大小和格式”：如：字符串的长度和标点符号。注4： “单位”：如：米、元、纳秒。注5： “准确性”：正确程度。注6： “精度”：有效数字位数。注7： “其它特性”可包括：“优先级别”，指在此接口上传输的数据元素的优先级别，如：哪些 数据优先访问等；“时序”，指在此接口上传输的数据元素在时间上的次序，以及保密性和私密性的 约束等。注8： “说明”：描述该数据元素的用途。数据元素集合体特性接口实体必须提供、存储、发送、访问、接收数据元素集合（记录、消息、文件、 显示、报告等）的特性。表10数据元素集合体特性数据元素集 合体名

9、称工程唯一 标识符集合体 类型包含的数据 元素名称数据元 素序号其它特性说明注1: “集合体类型”，如记录、消息、文件、数组、显示、报表等。注2： “数据元素序号”，指该数据元素在数据元素特性表中的顺序。注3： “其它特性”，可包括集合体间的关系，如排序/访问特性，如集合1访问集合2；显示和其 它输出的视听特性，如颜色、布局、字体、图标蜂鸣声、灯光；优先级别、时序、频率、容量、序 列、其它的约束条件，如：数据元素是否可被更新、业务规那么是否适用；保密性和私密性的约束等。 4. 3. 1.3.3 （通信方法特性）描述该接口的通信方法的特性。如CSCI对接口所用通信特性没有专门要求或前面 已统一描

10、述过，本节可省略；否那么参考4. 3. 1.2. 2节的格式进行描述。4. 3. 1.3.4 （协议特性）描述该接口的协议方法的特性。如CSCI对接口所用协议特性没有专门要求或前面 已统一描述过，本节可省略；否那么参考4. 3. 1.2. 3节的格式进行描述。5. 3. 1.3.5 其它特性描述接口其它所需的特性，如：接口实体的物理兼容性（尺寸、容错度、负荷、电 压和接插件兼容性等）。用户可根据实际情况自行设计表格或文字描述。6. 3.2内部接口设计内部接口设计的描述格式与外部接口设计相同，章节号、内容要求及提示等什么方 法参考4. 3.1各节；在Rose中，内部接口示意图应画出各软件单元之间

11、（部件包、类） 的接口关系。义X X义软件详细设计说明7. CSC I详细设计通过对每个类的详细描述来表达CSCI的详细设计。7.1 类名称/工程唯一标识符从5.1开始编号，对设计中类进行逐个说明。7.1.1 类属性描述表11类属性描述序 号名称标识符数据类型大小和格 式/单位范围/ 枚举准确性/ 精度其它 特性说明如果“类属性描述”表的“数据类型”有“自定义结构”，那么编写“自定义结构描 述”表进行描述，否那么去掉“自定义结构描述”表。表12自定义结构描述序 号名称标识符数据类型大小和格 式/单位范围/准确性/ 精度其它 特性说明类操作描述表13类操作描述操作名称工程唯一标识符功能描述7.1

12、.3 类操作详细设计类操作名称/工程唯一标识符对该类下的每个操作进行说明。（假设适用）用户的描述应包含以下各节信息，否那么 可注明“本节无内容”或“本节不适用”。数据元素/元素集合体定义对该操作所用到的数据元素或数据元素集合体进行定义，描述格式可参考4. 3. 1.3. 1和4. 3. 。如此内容已在前面描述可在此引用或省略。5. 1.3. 1.2所用算法该操作所用的算法，可用表格或文字形式进行。义XXX软件详细设计说明表14所用算法操作名定义说明算法描述：XXX o5. 1.3. 1.3所用逻辑本节描述内容可包括该类操作执行启动时，其内部起作用的条件；把控制交给其它 软件单元的条件；对每个输

13、入的响应及响应时间；该软件单元运行期间的操作序列和动 态控制序列；异常与错误处理等；本节可按表格或图表的形式给出，如对逻辑中的步骤 顺序，可用序列图表示。本节的局部内容如在前面已做描述，可引用或省略。5. 1.3. 1.4编程考前须知给出该类操作要引起编程人员注意的并发执行、响应时间等事项。5. 1.3. 1.5其它设计如有需要，给出软件单元设计中的约束、限制或非常规特征；要使用的规定CSCI 语言之外的编程语言和它的使用原理等。6需求可追踪性本文档对软件需求的追溯见表15和表16o表15需求的逆向追踪性软件单元软件需求名称/标识本文档的早1号名称/标识软件需求规格说明的章节号表16需求的正向

14、追踪性XXXX软件详细设计说明软件需求软件单元名称/标识软件需求规格说明的章节号名称/标识本文档的章节号7注解本章应包含有助于理解本文档的一般信息（例如背景信息、词汇表、原理）。附录（假设有）附录可用来提供那些为便于文档维护而单独出版的信息（例如图表、分类 数据）。为便于处理，附录可单独装订成册。附录应按数字顺序（1, 2等）编排。110（工程名称）软件详细设计说明 （宋体二号）XXX -XD-VX. X-X（宋体小二）编制（软件设计师）:日期:日期:日期:批准（工程技术负责人）:日期:（宋体三号）（工程名称）软件详细设计说明（宋体二号）XXX -XD-VX. X-X（宋体小二）. 日期： 日

15、期：标审：日期： 日期：（宋体三号）.II1范围1.1标识1.2系统概述1.3文档概述2引用文档错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。错误!未定义书签。3 CSCI级设计决策CSCI体系结构设计4.1 CSCI 部件错误!未定义书签。4.2执行方案错误!未定义书签。4.3平安性需求错误!未定义书签。5 CSCI详细设计错误!未定义书签。5.1 （软件单元的工程唯一的标识符，或者一组软件单元的标识符）错误！未定义书签。5.2 （软件单元的工程唯一的标识符，或者一组软件单元的标识符）错误！未定义书签。6需求可追踪性错误!未定义书

16、签。7注释错误!未定义书签。IIIxxxx软件详细设计说明1范围标识本文档适用的软件：a）软件标识：与总体规定的本软件标识一致；b）软件名称：与研制总要求中规定的本软件名称一致;c）软件简称：为软件名称的缩略表示；d）软件版本号：为本文档对应的软件的版本号。描述软件基本背景情况，可包括以下内容：a）系统和软件的一般特性；b）系统和软件的用途、使用对象和时机；c）整体的构成情况，以及该软件所处的位置（建议用图形描述，并辅以文字说明）;d）该软件的最终形态，如最终提交的段；e）说明研制状态，如新研、升级改进或移植等；f）概括系统开发、运行和维护的历史；g）标识工程的投资方（如合同甲方）、需方（如X

17、X研究所）、用户（如XX）、开发 方和保障机构；h）标识当前和计划的运行现场等。概括描述本文档的用途（包括其来源、作用、是编写哪些文档的依据等）、包括的 主要内容和与它的使用有关的保密性要求等。2引用文档在本文的正文中引用文档见表lo表1引用文档标识标题1XXXX软件详细设计说明标识标题3 CSC I级设计决策分小节描述CSCI行为的设计决策和其它影响组成该CSCI的软件单元的选择与设计 的决策；b）如果所有这些决策在CSCI需求中均是明确的，或者推迟到CSCI软件单元 设计中，应如实陈述；本章可引用软件需求规格说明（SRS）的相应内容。3.1 输入/输出设计决策3.1.1 （CSCI名称）的

18、输入/输出数据流图通过画出该CSCI的输入/输出数据流图来描述输入/输出决策，可引用外部接口示 意图。3.1.2 输入/输出说明表2输入/输出说明名称标识符类型描述注1： “类型，指出是输入/输出。注2： “描述”，指出其用途。3.1.3 1.3 CSCI的行为设计决策说明对每个输入或条件进行响应的CSCI行为的设计决策。表3 CSCI的行为设计决策注：“其它描述”：可包括被模式化的物理系统的描述、所选择的方程式/算法/规那么等。输入CSCI的动作CSCI的响应 时间输出对不允许的输入或 条件的处理其它描述3.2 CSCI的数据库/数据文件决策用文字描述CSCI数据库/数据文件如何呈现给用户的

19、设计决策。如果该信息的局部X X X X软件详细设计说明或全部已在数据库设计说明（DBDD）中给出，此处可引用。3.3 CSCI的平安性/保密性决策用文字描述CSCI为满足平安性、保密性需求所选用的有关方法。3.4 其它设计决策用文字描述对应于需求的其它CSCI级设计决策，如为提供所需的灵活性、可用性 和可维护性而选择的方法。4构件体系结构设计应在本章的开始给出软件构件的体系结构设计图，描述软件逻辑构成和部署关系。如果本软件构件中包含多个CSCI,应从4.1节开始分别对每个CSCI进行描述。在 ROSE中，CSCI体系结构设计可在Logical View下找出实现各Use Case描述功能的类

20、 或类的操作，然后把这些类归并到不同的逻辑包，如把所有的界面类都归并到公共类包, 并用类图描述各类之间的关系。如有可能，再把逻辑视图映射成部件视图（部件视图中 的每个部件都对应一个源文件，如C+中的.CPP和.H文件）。4.1 CSCI结构设计（部件）4. 1. 1 CSCI部件图画出整个CSCI的所有逻辑包视图的组成，要求画到类包（该包全部由类组成，不能 再划分为子包）一级。如有多个图示可分小节描述。例如：XXX后勤军需保障系统的逻辑部件视图（体系结构设计图）：图1 xx系统的逻辑包视图4. 1.2 CSCI部件描述表4 CSCI部件描述部件名称工程唯一标识 符用途相对应的需 求开发状态/类 型它的组成部件注：“开发状态/类型”：如新开发的部件、对已有的部件进行重用的部件、对已有设计进行重 用的部件、对再工程的已有设计或部件、开发的可重用的部件等等。对已有的设计或部件，应提供 诸如名称、版本、文档引用、地点等标识信息。