范例软件设计说明详细部分.docx
《范例软件设计说明详细部分.docx》由会员分享,可在线阅读,更多相关《范例软件设计说明详细部分.docx(14页珍藏版)》请在冰豆网上搜索。
![范例软件设计说明详细部分.docx](https://file1.bdocx.com/fileroot1/2022-10/24/99efdec5-8ee1-411a-a5bb-4c3062900e5f/99efdec5-8ee1-411a-a5bb-4c3062900e5f1.gif)
范例软件设计说明详细部分
软件设计说明
时间
版本号
修改人
修改内容
审批人
软件设计说明
1范围
1.1标识
要求:
本节应包含这个文档所适用的系统和软件的完全标识,(若适用)应包括标识号、名称、缩略名、版本号及发布号。
1.2系统概述
要求:
1)本节主要描述本文档适用的系统和软件的用途;
2)概述系统开发、运行和维护的历史;
3)标识项目的投资方、需方、用户、开发方和保障机构;
4)标识当前和计划的运行现场;
5)列出其它有关文档。
1.3文档概述
本节应概述本文档的用途和内容,描述与它的使用有关的保密性或私密性考虑。
2引用文档
列出引用的所有文档,包括文档的编号、标题、修订版本和日期。
3CSCI级设计决策
要求:
本章应根据需要分节给出CSCI级设计决策,即CSCI行为设计的决策(忽略其内部实现,从用户角度出发描述系统将怎样运转以满足需求)和其它影响组成该CSCI的软件单元的选择与设计的决策。
如果在需求中所有这些决策是明确的,或者这些决策要推迟到CSCI的软件单元的设计时指出,则本章应如实陈述。
针对关键性需求(例如对安全性、保密性、私密性等需求)作出的设计决策,应在专门的章节中加以叙述。
CSCI级设计决策的例子如下:
1)关于CSCI将接收的输入和将产生的输出的设计决策,包括与其它系统、HWCI、CSCI和用户的接口(本文档的4.3.x节指出本说明要考虑的主题);
2)有关响应每个输入或条件的CSCI行为的设计决策,包括CSCI要执行的动作、响应时间和其它性能特性,模型化的物理系统的说明,选定的方程式/算法/规则,以及对不允许的输入或条件进行的处理;
3)有关数据库/数据文件如何呈现给用户的设计决策(本文档的4.3.x节标识了本说明要考虑的主题)。
如果这一信息的全部或部分在数据库设计说明(DBDD)中给出,则可直接引用;
4)为满足安全性、保密性、私密性需求所选择的方法;
5)为满足需求所做的其它CSCI级设计决策,例如为提供所需的灵活性、可用性和可维护性所选择的方法。
【提示:
本章主要是要求从整体(系统/子系统级别)架构设计的层面,分不同视角(功能划分、性能、可靠性、安全性、灵活性、可维护性等)确定相应的关键设计机制,从而最终确定系统/子系统级别的体系结构设计。
】
4CSCI体系结构设计
要求:
本章应分为以下几节来描述CSCI体系结构设计。
如果设计信息在多于一个节中出现,它只需被提供一次,而在其它节中引用之。
【提示:
对各个CSCI(子系统)进行概要设计,拆分出各子系统包含的软件部件(模块)和各个软件部件包含的软件单元(子模块)。
】
以下4.1节分别对各个软件部件进行静态结构说明,4.2节对各个软件部件和软件单元进行动态行为关系说明。
4.1CSCI部件
要求:
本节应:
1)标识构成该CSCI的所有软件单元。
应赋予每个软件单元一个项目唯一标识符;
【注:
软件单元是CSCI设计中的一个元素;例如,CSCI的一个主要分支、该主要分支的一个组成部分,一个类、对象、模块、函数、例程或数据库。
软件单元可以出现在层次结构的不同层上,且又可以由其它软件单元组成。
在设计中,软件单元与实现它们的代码和数据实体(例程,过程,数据库,数据文件等),或与包含这些实体的计算机文件之间,可以有、也可以没有一对一的对应关系。
一个数据库可被处理为一个CSCI也可被处理为一个软件单元。
SDD可以采用与所使用设计方法相一致的任何名字来称呼软件单元。
】
2)给出软件单元的静态(如,由…组成)关系。
根据所选择的软件设计方法学,可以给出多种关系(例如,采用面向对象的设计方法时,本节既可给出类和对象结构,也可给出CSCI的模块和过程结构);
3)说明每个软件单元的用途,指明分配给它的CSCI需求和CSCI级设计决策(需求的分配也可在6.a中提供);
4)标识每个软件单元的开发状态/类型(如新开发、按原样重用已有的设计或软件、再工程的已有的设计或软件、为重用而要开发的软件等,为构建版N计划的软件)。
针对现有的设计或软件,本说明应提供标识信息,例如名字、版本、文档引用、库等;
5)说明CSCI(若适用,针对每个软件单元)计划使用的计算机硬件资源(例如处理机能力,内存能力,输入/输出设备能力,辅存能力以及通信/网络设备能力)。
本说明应覆盖CSCI的资源使用需求中、影响该CSCI的系统级资源分配中、以及在软件开发计划(SDP)的资源使用测量策划的中包含的全部计算机硬件资源。
如果针对给定计算机硬件资源的所有使用数据都在同一处提供,例如在SDD中提供,那么本节可直接引用。
对每个计算机硬件资源,应包括如下信息:
a)得到满足的CSCI需求或系统级资源分配;
b)使用数据基于的假设和条件(例如,典型用法、最坏情况用法、特定事件的假定);
c)影响使用的特殊考虑(例如,虚存、覆盖、多处理器的使用情况,操作系统、库软件的开销或其它实现开销影响);
d)所使用的测度的单位(例如,处理器能力的百分比、周期/秒、内存字节数、千字节/秒);
e)进行评估或测量的级别(例如,软件单元,CSCI或者可执行程序);
f)标识实现每个软件单元的软件放置在哪个程序库中(若适用)。
【提示:
本章主要是要求从整体架构设计的层面,分不同视角(功能划分、性能、可靠性、安全性、灵活性、可维护性等)确定相应的关键设计机制,从而最终确定系统的体系结构设计。
】
4.2执行方案
本节应说明软件单元间的执行方案。
应采用图表和描述,说明软件单元间的动态关系,即CSCI运行期间软件单元间的相互作用情况,(若适用)应包括执行控制流程、数据流、动态控制序列、状态转换图、时序图、单元间的优先关系、中断处理、时序/排序关系、例外处理、并发执行、动态分配与去除分配、对象/进程/任务的动态创建/删除、以及动态行为的其它方面。
4.3接口设计
4.3.1接口标识和接口图
要求:
本节应说明赋予每个接口的项目唯一的标识符,(若适用)应通过名称、编号、版本及文档引用来标识接口实体(软件单元、系统、配置项、用户等)。
该标识应说明哪些实体具有固定的接口特性(从而把接口需求分配给这些接口实体);说明哪些实体正在开发或修改(这些实体已有各自的接口需求)。
(若适用)应通过接口图来描述这些接口。
【提示:
对系统外部接口、内部接口(子系统与子系统、部件与部件、软件单元与软件单元)采用接口结构图、接口汇总表等形式对所有接口进行定义和标识。
】
4.3.x(接口的项目唯一标识符)
要求:
本节(从4.3.2开始)应通过项目唯一标识符来标识接口,应简要地标识接口实体,根据需要可分节描述单方或双方接口实体的特性。
如果一给定的接口实体未包含在本SDD中(例如,一个外部系统),而描述接口实体需要提到其接口特性时,这些特性应作为假设予以陈述、或以“当[未涵盖的实体]这样做时,[所指定的实体]将……”的形式描述。
本节可引用其它文档(例如数据字典、协议标准、用户接口标准)代替在此所描述的信息。
本设计说明应包括以下内容(若适用),以任何适合于所提供的信息的顺序提供,并应从接口实体角度说明这些特性之间的区别(例如关于数据元素的大小、频率或其它特性的不同期望):
1)接口实体分配给接口的优先级;
2)要实现的接口类型(例如实时数据传输、数据的存储和检索等);
3)接口实体将提供、存储、发送、访问、接收的各个数据元素的特性,例如:
a)名称/标识符:
●项目唯一的标识符;
●非技术(自然语言)名称;
●数据元素名称;
●技术名称(如在代码或数据库中的变量名或字段名);
●缩略名或同义名。
b)数据类型(字母数字、整数等);
c)大小与格式(如:
字符串的长度和标点符号);
d)计量单位(如:
米、元、纳秒);
e)可能值的范围或枚举(如:
0-99);
f)准确性(正确程度)和精度(有效数位数);
g)优先级、时序、频率、容量、序列以及其它约束条件(例如数据元素是否可以被更新、业务规则是否适用);
h)保密性与私密性约束;
i)来源(建立/发送的实体)和接受者(使用/接收的实体)。
4)接口实体将提供、存储、发送、访问、接收的数据元素集合体(记录、消息、文件、数组、显示、报表等)的特性,例如:
a)名称/标识符:
●项目唯一的标识符;
●非技术(自然语言)名称;
●技术名称(如在代码或数据库中的记录名或数据结构名);
●缩略名或同义名。
b)数据元素集合体中的数据元素及其结构(编号、顺序和分组情况);
c)介质(例如磁盘)以及介质上数据元素/数据集合体的结构;
d)显示和其它输出的视听特性(例如颜色、布局、字体、图标和其它显示元素、峰鸣声和亮度);
e)数据集合体之间的关系,如排序/存取特性;
f)优先级、时序、频率、容量、序列及其它约束,例如数据集合体是否可被更新、业务规则是否适用;
g)保密性与私密性约束;
h)来源(建立/发送的实体)和接受者(使用/接收的实体)。
5)接口实体用于接口的通信方法的特性。
如:
a)项目唯一的标识符;
b)通信链接/带宽/频率/介质及其特性;
c)消息格式;
d)流控制(如:
序列编号和缓冲区分配);
e)数据传输率、周期或非周期、传输间隔;
f)路由、寻址及命名约定;
g)传输服务,包括:
优先级和等级;
h)安全性/保密性/私密性考虑,如:
加密、用户鉴别、隔离和审核。
6)接口实体用于接口的协议的特性,如:
a)项目唯一的标识符;
b)协议的优先级别/层次;
c)打包,包括分段与重组、路由和寻址;
d)合法性检查、错误控制和恢复过程;
e)同步,包括连接的建立、保持和终止;
f)状态、标识和其它报告特性。
7)其它特性,例如接口实体的物理兼容性(尺寸、公差、负荷、电压和接插件的兼容性等)。
【提示:
对每个接口从源对象、目标对象、数据结构和属性、接口类型、优先级、其他质量特性等方面进行详细说明。
】
5CSCI详细设计
5.1XX软件单元
5.1.1流程设计
在收到ERQ消息时系统会根据ATM地址判断是否为本局地址,如果不是则启动交换入局连接建立流程,向节点发送交换连接建立请求,从而要求交换出局协议实体向ANI对应局向发送ERQ消息,并在收到ECF后向交换入局方发送连接建立证实消息。
交换入局在收到该消息后会将承载入局连接和承载出局连接的两块APB板连接起来,并向连接发起端发送ECF消息,从而完成连接的建立。
Ø正常流程
(1)A2SP入局实体从邻接局接收到ERQ消息
(2)A2SP入局实体向A2SP节点功能发送入局连接指示。
(3)A2SP节点功能请求数据库根据ATM地址查询目标ANI。
(4)DBS查询ATM地址与ANI的静态关系配置表,向A2SP节点功能返回ANI。
(5)A2SP判别出ANI不为0(即不是本网元终结)时,认为是AAL2中继交换场景,否则即AAL2终结点场景。
设置协议实体ActOrd为LINKMIDSTART。
A2SP请求DBS检查CEID的有效性。
(6)DBS调用事业部注册的回调函数,回调函数中对入局段进行接纳控制。
(7)DBS返回CEID检查结果,接口中包含APB1的媒体面地址