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

方案评审文件（三号宋体）密级：（三号宋体） （产品名称） 软件设计说明 （黑体二号）XX公司 XXXX年XX月（宋体三号） XXXX保障系统 图1 XXXX保障系统的逻辑包视图 4. 2.2软件配置项部件描述表4软件配置项部件描述 部件名称 工程唯一标识 符 用途 相对应的需 求 开发状态/类 型 它的组成部件 “开发状态/类型”：如新开发的部件、对已有的部件进行重用的部件、对已有设计 进行重用的部件、对再工程的已有设计或部件、开发的可重用的部件等等。对已有的设 计或部件，应提供诸如名称、版本、文档引用、地点等标识信息。 4. 2.3软件配置项类图 4. 2. 3. 1类包名称 应当对每个类包的类图进行说明。 4. 2. 3. 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设计中的所有活动图并配以文字说明，如有多个图形可分 小节分别描述。否那么本节可省略。 4. 3.2软件配置项交互图 如存在的话，画出CSCI设计中的所有交互图并配以文字说明，如有多个图形可分 小节分别描述。否那么本节可省略。 4. 3.3软件配置项状态图 如存在的话，画出CSCI设计中的所有状态图并配以文字说明，如有多个图形可分 小节分别描述。否那么本节可省略。 4. 3.4软件配置项进程图 尽可能画出CSCI设计中的部件执行图(Component View)来反映CSCI进程间的调 度关系并配以文字说明各进程的激发结束等条件，如有多个图形可分小节分别描述。否 那么本节可省略。 4. 3.5其它动态行为设计 如需要，用文字或其它方法来描述CSCI的其它动态行为。 4.4性能设计 如有性能需求，从精度、时间特性、可靠性等方面描述采用何种性能设计措施实现 性能需求。如果所有有关可靠性设计的内容单独成册，那么需在此说明。 4.5接口设计 主要描述软件单元的接口特性，既包括软件单元之间的内部接口，也包括与外部实 体，如系统、配置项、用户之间的接口；只需描述对软件需求规格说明(SRS)中的接口 需求局部做出修改或增加的接口，其余相同的局部可在此引用；如果本节局部内容已在 接口设计说明(IDD)中给出，那么在此引用不必具体描述。如接口设计说明中没有提供， 那么一定要在此处给出。 4. 5. 1外部接口设计 人机接口是一种外部接口，如有人机接口，那么在本节的子章节描述人机接口及其界 面设计。 4. 5. 1. 1外部接口示意图 CSCI的外部接口将CSCI作为一个整体来考虑，即描述和与它共享数据、向它提供 数据或与它交换数据的外部实体的关系。在Rose中，接口设计示意图可通过在Logical View下的类图来表示。 图8 XXXX保障系统外部接口示意图 4.5. 1.2外部接口描述XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX XXXXXXXXXXXXXo 4.5. 1.2. 1外部接口标识表6外部接口标识 接口名称 工程唯一 标识符 需求描述 接口类型 接口优先 级别 发送方名 称/标识符 接收方名 称/标识符 注1: “接口类型”：如实时数据传送、数据的存储和检索等。 注2： “发送方”、“接收方”：指CSCI、用户等接口实体。 4.5. 1.2. 2通信方法特性 描述接口实体为外部接口使用的通信方法的特性。如接口实体对接口通信特性没有 专门要求，本节可省略。如果所有外部接口使用的通信方法是统一的，那么在此处描述。 在以下各接口的详细描述中就不再重复有关内容；如果各外部接口使用的通信方法是不 同的，那么应在以下各接口的详细描述中用类似下表的格式分别描述，而本节可省略。 下表仅供用户参考，用户可根据实际情况对要说明的内容添加或删除，也可自己设 计表格或用文字描述。 表7外部接口的通信方法特性注1：数据传送特性，包括传送速率、周期或非周期以及传送间隔。 通信方法 名称 工程唯一标 识符 通信链路/带宽/频率特性 数据传送特性 其它特性 注2：其它特性，可包括：传输服务，包括：优先级别和等级；平安性/保密性/私密性方面的考 虑，如：加密、用户鉴别、隔离、审计等；流控制（如：序列编号和缓冲区分配）；消息格式化；路 由、寻址、命名约定