软件文档模板-软件详细设计说明.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中,内部接口示意图应画出各软件单元之间
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 文档 模板 详细 设计 说明
限制150内