软件文档模板-软件设计说明

1、方案评审文件（三号宋体）密级：（三号宋体）（产品名称）软件设计说明（黑体二号）XX公司XXXX年XX月（宋体三号）XXXX保障系统图1 XXXX保障系统的逻辑包视图4. 2.2软件配置项部件描述表4软件配置项部件描述部件名称工程唯一标识 符用途相对应的需 求开发状态/类 型它的组成部件“开发状态/类型”：如新开发的部件、对已有的部件进行重用的部件、对已有设计 进行重用的部件、对再工程的已有设计或部件、开发的可重用的部件等等。对已有的设 计或部件，应提供诸如名称、版本、文档引用、地点等标识信息。4. 2.3软件配置项类图4. 2. 3. 1类包名称应当对每个类包的类图进行说明。4. 2. 3.

2、1.1类图名称应当画出该类包的所有类图。例如：4. 1. 3. 1. 1 XXXX系统应用类包的类图：图4 XXXX系统应用类包的类图4. 2. 3. 1.2类说明对该类包下的所有类进行说明。表5类说明注1：实现的程序名称指编程时实现该类的源程序名称。类名称用途开发状态/类型实现的程序 名称备注注2：假设适用，备注可指出每个软件单元（类）所使用的计算机硬件资源。4.3执行概念本节描述软件单元间的执行概念。应包含表示软件单元之间动态关系的图示和说 明，即CSCI操作期间它们如何交互。4. 3. 1软件配置项活动图如存在的话，画出CSCI设计中的所有活动图并配以文字说明，如有多个图形可分 小节分别

3、描述。否那么本节可省略。4. 3.2软件配置项交互图如存在的话，画出CSCI设计中的所有交互图并配以文字说明，如有多个图形可分 小节分别描述。否那么本节可省略。4. 3.3软件配置项状态图如存在的话，画出CSCI设计中的所有状态图并配以文字说明，如有多个图形可分 小节分别描述。否那么本节可省略。4. 3.4软件配置项进程图尽可能画出CSCI设计中的部件执行图(Component View)来反映CSCI进程间的调 度关系并配以文字说明各进程的激发结束等条件，如有多个图形可分小节分别描述。否 那么本节可省略。4. 3.5其它动态行为设计如需要，用文字或其它方法来描述CSCI的其它动态行为。4.4

4、性能设计如有性能需求，从精度、时间特性、可靠性等方面描述采用何种性能设计措施实现 性能需求。如果所有有关可靠性设计的内容单独成册，那么需在此说明。4.5接口设计主要描述软件单元的接口特性，既包括软件单元之间的内部接口，也包括与外部实 体，如系统、配置项、用户之间的接口；只需描述对软件需求规格说明(SRS)中的接口 需求局部做出修改或增加的接口，其余相同的局部可在此引用；如果本节局部内容已在 接口设计说明(IDD)中给出，那么在此引用不必具体描述。如接口设计说明中没有提供， 那么一定要在此处给出。4. 5. 1外部接口设计人机接口是一种外部接口，如有人机接口，那么在本节的子章节描述人机接口及其界

5、 面设计。4. 5. 1. 1外部接口示意图CSCI的外部接口将CSCI作为一个整体来考虑，即描述和与它共享数据、向它提供 数据或与它交换数据的外部实体的关系。在Rose中，接口设计示意图可通过在Logical View下的类图来表示。图8 XXXX保障系统外部接口示意图4.5. 1.2外部接口描述XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXo4.5. 1.2. 1外部接口标识表6外部接口标识接口名称工程唯一 标识符需求描述接口类型接口优先 级别发送方名 称/标识符接收方名 称/标识符注1: “接口类型”：如实时数据传送、数据的存储和检索等。

6、注2： “发送方”、“接收方”：指CSCI、用户等接口实体。4.5. 1.2. 2通信方法特性描述接口实体为外部接口使用的通信方法的特性。如接口实体对接口通信特性没有 专门要求，本节可省略。如果所有外部接口使用的通信方法是统一的，那么在此处描述。 在以下各接口的详细描述中就不再重复有关内容；如果各外部接口使用的通信方法是不 同的，那么应在以下各接口的详细描述中用类似下表的格式分别描述，而本节可省略。下表仅供用户参考，用户可根据实际情况对要说明的内容添加或删除，也可自己设 计表格或用文字描述。表7外部接口的通信方法特性注1：数据传送特性，包括传送速率、周期或非周期以及传送间隔。通信方法 名称工程

7、唯一标 识符通信链路/带宽/频率特性数据传送特性其它特性注2：其它特性，可包括：传输服务，包括：优先级别和等级；平安性/保密性/私密性方面的考 虑，如：加密、用户鉴别、隔离、审计等；流控制（如：序列编号和缓冲区分配）；消息格式化；路 由、寻址、命名约定等内容。协议特性描述接口实体为外部接口使用的协议方法的特性。如接口实体对接口协议特性没有 专门要求，本节可省略。如果所有外部接口使用的协议方法是统一的，那么在此处描述。 在以下各接口的详细描述中就不再重复有关内容；如果各外部接口使用的协议方法是不 同的，那么应在以下各接口的详细描述中用类似下表的格式分别描述，而本节可省略。下表仅供用户参考，用户可

8、根据实际情况对要说明的内容添加或删除，也可自己设计表格或用文字描述。表8外部接口的协议特性注1：分组，包括：分段和重组、路由、寻址。协议方法 名称工程唯一 标识符优先级/层分组同步其它特性注2：同步，包括：连接的建立、维护、终止。注3：其它特性，可包括：合法性检查、错误控制和恢复过程；状态、标识、任何其它的报告特征等内容。1.3外部接口名称/工程唯一标识符对所有外部接口分小节进行说明，在标题处填上各外部接口的名称或标识符。下表仅供用户参考，用户可根据实际情况对要说明的内容添加或删除，也可自己设 计表格或用文字描述。数据元素特性描述接口实体必须提供、存储、发送、访问、接收的单个数据元素的特性。表

9、9数据元素特性注1： “序号”：对数据元素从1开始进行编号。-序号名称工程唯一 标识符数据 类型大小和格 式/单位范围/ 枚举准确性/ 精度其它特性说明注2： “数据类型”：指字母数字、字符、整数等。注3： “大小和格式”：如：字符串的长度和标点符号。注4： “单位”:如：米、元、纳秒。注5： “准确性”:正确程度。注6： “精度”：有效数字位数。注7： “其它特性”可包括：“优先级别”，指在此接口上传输的数据元素的优先级别，如：哪些 数据优先访问等；“时序”，指在此接口上传输的数据元素在时间上的次序，以及保密性和私密性的 约束等。8“说明”：描述该数据元素的用途。4. 5. 1.3. 2数据

10、元素集合体特性接口实体必须提供、存储、发送、访问、接收数据元素集合（记录、消息、文件、 显示、报告等）的特性。表10数据元素集合体特性注1: “集合体类型”，如记录、消息、文件、数组、显示、报表等。数据元素集 合体名称工程唯一 标识符集合体 类型包含的数据 元素名称数据元 素序号其它特性说明数据元素集 合体名称工程唯一 标识符集合体 类型因色的数据 元素名称数据元 素序号其它特性说明注2： “数据元素序号”，指该数据元素在数据元素特性表中的顺序。注3： “其它特性”，可包括集合体间的关系，如排序/访问特性，如集合1访问集合2；显示和 其它输出的视听特性，如颜色、布局、字体、图标蜂鸣声、灯光；优

11、先级别、时序、频率、容量、 序列、其它的约束条件，如：数据元素是否可被更新、业务规那么是否适用；保密性和私密性的约束 等。4. 5. 1.3. 3 （通信方法特性）描述该接口的通信方法的特性。如CSCI对接口所用通信特性没有专门要求或前面已 统一描述过，本节可省略；否那么参考4. 3. 1.2. 2节的格式进行描述。4. 5. 1.3.4 （协议特性）描述该接口的协议方法的特性。如CSCI对接口所用协议特性没有专门要求或前面已 统一描述过，本节可省略；否那么参考4. 3. 1.2. 3节的格式进行描述。4. 5. 1.3. 5 其它特性描述接口其它所需的特性，如：接口实体的物理兼容性（尺寸、容

12、错度、负荷、电 压和接插件兼容性等）。用户可根据实际情况自行设计表格或文字描述。内部接口设计内部接口设计的描述格式与外部接口设计相同，章节号、内容要求及提示等什么方 法参考4. 3.1各节；在Rose中，内部接口示意图应画出各软件单元之间（部件包、类） 的接口关系。5需求可追踪性本文档对软件需求的追溯见表11和表12o表11需求的正向追踪性表12需求的逆向追踪性软件需求软件单元名称/标识软件需求规格说明的章节号名称/标识本文档的草B号名称/标识本文档的阜P号名称/标识软件需求规格说明的章节号软件单元软件需求6数据库概述简要说明本文档所适用的数据库的用途。描述数据库的一般特性；通常应概述其开 发

13、、使用和维护的历史；指出工程的提出方、需方、用户、开发方和支持部门；标识当 前和计划使用的运行场地；并列出其它相关文档。7数据库级设计决策根据需要说明数据库级设计决策，即数据库行为设计决策（从用户的角度看，该数 据库如何满足它的需求而忽略内部实现）和其它影响数据库进一步设计的决策。数据库输入/输出接口设计决策描述数据库应接受的查询或其它输入和它应产生的输出（显示、报告、消息、响应 等）的设计决策，包括与其它系统、HWCI、CSCI和用户的接口。可引用相关接口设计文 档。数据库响应的设计决策描述对每一个输入、查询的响应，响应时间、其它性能特性、所选择的方程式/算 法/准那么、配置以及对不允许的输

14、入的处理的设计决策。选用的数据库管理系统采用的数据库管理系统（包括名称、版本/发行号）。4数据库/数据文件的形式及物理存贮数据库/数据文件在用户面前应如何呈现的设计决策，它包括数据库/数据文件的形 式及物理存贮方式。数据库分布数据库分布（例如客户/服务器）、主数据库文件的更新和维护等的设计决策，包括 一致性的维护、同步的建立/重建以及维持、完整性以及业务规那么的实施等。10数据库的平安与保密有关数据库将要提供的可用性、平安性、私密性以及操作连续性的权限等级和类型 的设计决策。数据库的备份和恢复包括数据和处理的分布策略、备份和恢复过程中允许的活动以及对新的或非标准技 术（如视频和声音等）的特殊考

15、虑。自动磁盘管理和空间回收优化的考虑说明有关重新包装、排序、索引、同步与一致性的设计决策，包括自动的磁盘管理 和空间回收的考虑，优化的策略和考虑、存储和尺寸考虑、以及数据库内容的增生和遗 产数据的获取。8数据库的详细设计这个局部可结合数据库设计工具如：ERwin,根据设计级别分成小节来描述数据库 的详细设计，详细信息可以由数据库设计工具产生。以下设计中以Erwin为例，说明了 如何由数据库设计工具自动产生设计图的方法。数据库概念设计本小节从现实世界出发考虑数据库设计是如何满足用户需求的，是实体级设计。数据库E-R设计图本小节E-R图如果由ERwin自动产生，那么取自ERwin逻辑图，应包括实体

16、（entity 级气图1数据库E-R设计图8. 1.2 E-R设计图说明本小节如果由ERwin自动产生，可在ERwin的Report中选择Entity name/Entity definition,注意输出时，Export 选择 DDE, Presentation 选择 Tabular。表13数据库E-R实体表实体名称实体描述8.2数据库逻辑设计本小节从逻辑上考虑数据库设计是如何满足用户需求的，忽略其内部实现，是实体 属性级设计。8. 2.1数据库逻辑模式(逻辑图)本小节中逻辑图中应包括实体(Attribute级显示，包含主键、外键)、实体间关系 (包含关系谓词表达式)。例如：雇员租片记录久雇

17、员号日 名址编话雇 姓地邮电受Q.雇员号(FK)Q.租片号Q电影号(FK) 风客户号(FK)。付款号客户号(FK) 雇员号(FK) 类型 金额 日期 支票帐号 信用卡号客户-0 /on号 日 款期还金款 付日应租罚拥有观客户号姓电地邮名话址编名片演角级金 影导主等租图2数据库逻辑模式图8. 2.2数据库逻辑模式说明XXXXXXXXXXXXXXXXXXXXXXo8. 2. 2. 1逻辑模式说明本小节从用户角度说明实体名称、属性、主键，如果是外键需说明父实体名称。如 果由 ERwin 自动产生，可在 ERwin 的 Report 中选择 Entity name/Entity Attribute N

18、ame/Entity Attribute Is PK/ Entity Attribute Is FK/Entity Parent Ralationship Parent Entity Name 项，输出时，Export 选择 DDE, Presentation 选择 Master-detail。表14实体名称:属性主键外键父实体名称逻辑模式关系说明本小节从用户角度说明实体间关系。如果由ERwin自动产生,可在ERwin的Report 中选择 Relationship Parent to Child Phrase/Relationship Parent to Child Rule/Relatio

19、nship Child to Parent Rule/Relationship Parent Entity Name/Relationship Child Entity Name 项，输出时，Export 选择 DDE, Presentation 选择 Tabularo表15数据库逻辑模式关系说明父实体子实体父-子 关系父-子关系 描述子-父关系描述父实体主键名子实体主键名8.3数据库物理设计本小节从物理上考虑数据库设计是如何实现用户需求的，结合所选取的目标数据 库，详细描述数据元素和数据元素集合体。138. 3.1数据库物理模式（物理图）本小节中物理图中应包括实体（Column级显示，包含视

20、图、主键、外键）、实体间 关系（包含关系谓词表达式）。例如：8. 3.2数据库物理模式说明XXXXXXXXXXXXXXXXXXXXXXo独立的数据元素这一小节如果由ERwin自动产生，可在ERwin的Report中选择Attribute name/Attribute column Name/ Attribute column Datatype/Attribute Definition 项,输出时，Export 选择 DDE, Presentation 选择 Tabular）。表16数据库独立数据元素表注：备注中，可加入度量单位（例如米、美元、纳秒）、取值范围（例如0-99）或枚举、正确 性和精

21、确度（有效数字位数及误差等）、优先级、定时性、出现频率、容量大小、出现顺序和其它约 束，例如，该集合体可否被更新，适用哪种业务规那么，保密和私密约束、来源方（设置/发送的实体） 和接收方（使用/接收的实体）等。这局部内容在ERwin的逻辑图中，加在Attribute Definition 或在物理图中，加在Column Comment中。属性名称字段名称数据类型备注8. 3. 2. 2数据元素集合体（表结构说明）本小节详细描述数据库中的表结构。如果由ERwin自动产生,可在ERwin的Report 中选择 Table Entity Name/Table Name/Table Column Na

22、me/Table Column Attribute Name/Table Column Datetype/Table Column Null Option/Table Column Is PK/Table Column Is Fk 项，输出时，Export 选择 DDE, Presentation 选择 Master-Tabular。表名:标识:字段名称属性名称数据类型是否为空主键外键143. 2. 3其他数据库对象以下分节表达数据库中视图、触发器、过程、函数、序列等数据库对象。9用于数据库访问或操纵的软件单元的详细设计描述用于数据库访问或操纵的每个软件单元。如果该信息的局部或全部已在别处提

23、供，如在软件设计说明（SDD）、或商用的DBMS的用户手册等处，在此可引用该信息， 而无需重复说明。软件单元名称设计表17软件单元名称设计软件单 元名称工程唯一 标识符访问表结构 名称相关数据库操作所含逻辑对应的软件 详细设计章节特定的要求注：特殊要求包括所使用的算法、特殊的设计约束、限制、或特定的要求等。1. 1其它设计如有必要，可在此描述该软件单元访问数据库相关接口的详细信息。格式可参考软 件设计说明或接口设计说明有关规定。否那么，本节可省略。10需求可追踪性本文档对软件需求的追溯见表7和表8O表18需求的正向追踪性软件需求软件单元名称/标识软件需求规格说明的章节号名称/标识本文档的早节号

24、表19需求的逆向追踪性15软件单元软件需求名称/标识本文档的早节号名称/标识软件需求规格说明的章节号名称/标识本文档的早T号名称/标识软件需求规格说明的章节号软件单元软件需求11注解本章应包含有助于理解本文档的一般信息（例如背景信息、词汇表、原理）。附录（假设有）附录可用来提供那些为便于文档维护而单独出版的信息（例如图表、分类 数据）。为便于处理，附录可单独装订成册。附录应按数字顺序（1, 2等）编排。16签署页（宋体2号）编制 （软件设计师）:日期:校对 （软件设计师）： 日期: 审核 （软件负责人）： 日期: 标审（单位工程管理员）： 日期: 会签（单位研发部门负责人）： 日期: 批准（工

25、程技术负责人）： 日期:（宋体三号）签署页（宋体2号） 日期：校对：日期： 日期：标审：日期： 日期：会签：日期：（宋体三号）II TOC o 1-5 h z 1范围1标识1系统概述11. 3文档概述12引用文档13设计决策23. 1输入/输出设计决策 23.1.1 （软件配置项名称）的输入/输出数据流图23. 1.2输入/输出说明23. 1.3 CSCI的行为设计决策23. 2软件配置项的数据库/数据文件决策23. 3软件配置项的平安性/保密性决策33. 4其它设计决策34体系结构设计34.1逻辑结构及部署关系34. 2软件配置项部件34. 2. 1软件配置项部件图34. 2. 2软件配置项

26、部件描述44. 2. 3软件配置项类图44. 3执行概念54. 3. 1软件配置项活动图54. 3.2软件配置项交互图64. 3. 3软件配置项状态图6软件配置项进程图64. 3. 5其它动态行为设计64. 4性能设计64.5接口设计64. 5. 1外部接口设计64. 5.2内部接口设计95需求可追踪性96数据库概述107数据库级设计决策10数据库输入/输出接口设计决策102数据库响应的设计决策10I TOC o 1-5 h z 选用的数据库管理系统10数据库/数据文件的形式及物理存贮105 数据库分布 10数据库的平安与保密11数据库的备份和恢复11自动磁盘管理和空间回收优化的考虑 118数

27、据库的详细设计118.1数据库概念设计118. 1. 1数据库E-R设计图118. 1.2 E-R设计图说明 128. 2数据库逻辑设计128. 2.1数据库逻辑模式（逻辑图） 128. 2.2数据库逻辑模式说明138. 3数据库物理设计138. 3. 1数据库物理模式（物理图） 14数据库物理模式说明149用于数据库访问或操纵的软件单元的详细设计159.1软件单元名称设计159. 1. 1其它设计1510需求可追踪性1511注解16附录16II1范围xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx XXXXXXXXXXXXXo标识本文档适用的软件：a）软件标识：与总体规

28、定的本软件标识一致；b）软件名称：与研制总要求中规定的本软件名称一致；C）软件简称：为软件名称的缩略表示；d）软件版本号：为本文档对应的软件的版本号。系统概述描述软件基本背景情况，可包括以下内容：a）系统和软件的一般特性；b）系统和软件的用途、使用对象和时机；c）整体的构成情况，以及该软件所处的位置（建议用图形描述，并辅以文字说 明）；d）该软件的最终形态，如最终提交的段；e）说明研制状态，如新研、升级改进或移植等；f）概括系统开发、运行和维护的历史；g）标识工程的投资方（如合同甲方）、需方（如XX研究所）、用户（XX）、开发 方和保障机构；h）标识当前和计划的运行现场等。文档概述概括描述本文档的用途（包括其来源、作用、是编写哪些文档的依据等）、包括的 主要内容和与它的使用有关的保密性要求等。2引用文档在本文的正文中引用文档见表lo表1引用文档标识标题3设计决策分小节描述CSCI行为的设计决策和其它影响组成该CSCI的软件单元的选择与设计 的决策；b）如果所有这些决策在CS