软件概要设计说明书模版
软件项目概要设计说明书模板

软件项目概要设计说明书模板XXXXXX公司二零二三年十二月第 1页共14页修订记录第 2页共14页目录目录 (3)1文档介绍 (5)1.1文档目的 (5)1.2文档范围 (5)1.3读者对象 (5)1.4参考文献 (5)1.5术语与缩写解释 (5)2系统概述 (6)3设计约束 (6)4系统总体功能结构 (7)4.1系统管理子模块 (7)4.1.1系统管理子模块功能结构 (7)4.1.2系统管理子模块功能描述 (7)4.2XX子模块 (8)4.2.1XX子模块功能结构 (8)4.2.2XX子模块功能描述 (8)4.3党委个人XXXX子模块 (9)4.3.1党委个人XXXX子模块功能结构 (9)4.3.2个人XXXX模块功能描述 (9)4.4XX子模块 (9)4.4.1XX模块功能结构 (9)4.4.2子模块功能描述 (9)4.5消息管理子模块 (10)4.5.1消息管理子模块功能结构 (10)4.5.2消息管理子模块功能描述 (10)4.6汇总统计子模块 (10)第 3页共14页4.6.1汇总统计子模块功能结构 (10)4.6.2汇总统计子模块功能描述 (10)4.7预警提醒子模块 (11)4.7.1预警提醒子模块功能结构 (11)4.7.2预警提醒子模块功能描述 (11)4.8和XXX数据同步子模块 (11)4.8.1和XXX数据同步模块功能结构 (11)4.8.2和XXX数据同步子模块功能描述 (11)5开发环境的配置 (12)6运行环境的配置 (13)7测试环境的配置 (14)第 4页共14页1文档介绍1.1文档目的本文档作为详细设计阶段所提交材料的重要组成部分,内含设计策略,软件联系逻辑,系统总体结构以及子系统的结构和功能,为产品后续开发提供重要参考。
1.2文档范围针对做个性概要分析设计。
适用于整个XXXX系统的开发过程。
1.3读者对象本说明书适用于项目设计人员、开发人员、测试人员、文档编写人员、工程实施人员。
(完整word版)概要设计说明书模板

软件概要设计说明书模板(V1.0)文档编号:文档名称:编写:编写日期:审核:审核日期:批准:批准日期:<项目名称>软件概要设计说明书(版本号)文档编号:项目名称:编写:编写日期:审核:审核日期:批准:批准日期:文档修订记录目录第1章引言 (6)1.1 编写目的 (6)1.2 预期读者 (6)1.3 编写背景 (7)1.3.1系统名称及版本号 (7)1.3.2任务提出者 (7)1.3.3任务承接者及实施者 (7)1.3.4使用者 (7)1.3.5与其它系统的关系 (7)1.4 文档结构 (8)1.5 术语定义 (8)1.6 电子文档编写工具 (8)1.7 参考资料 (8)第2章系统概述 (9)2.1系统目标 (9)2.2设计原则 (9)2.3运行环境 (9)2.3.1硬件平台 (9)2.3.2软件平台 (9)2.3.3网络体系结构 (9)2.4系统整体结构概述 (10)2.5需求功能覆盖关系说明 (10)2.6关键技术 (10)第3章系统功能说明 (11)3.1系统功能概述 (11)3.2系统外部接口 (11)3.3子系统功能说明 (12)3.4模块层次结构图 (13)3.5模块1 (13)3.5.1模块功能描述 (13)3.5.2功能模块的主要流程说明 (13)3.5.3功能点名称1 (13)第4章数据库设计 (15)第5章用户界面设计 (15)5.1基本原则 (15)5.2设计规范 (15)第6章出错处理设计 (15)6.1出错信息 (15)6.2补救措施 (15)第7章需求可追踪性 (16)附录 (17)代码表手册 (17)设计与编程规范、惯例及约定 (17)1数据库设计规范 (17)2编程规范 (17)3用户界面规范 (17)第1章引言1.1 编写目的【说明】本文档是以《软件需求分析说明书》为基础,进一步就《软件需求分析说明书》中的功能从计算软件实现的角度给出的设计描述。
即是对需求分析说明书中的功能以计算机软件设计的角度,对上述功能的实现进行合理的功能模块的划分、对上述功能模块的所包含的功能点进行描述和说明,必要的情况下可以程序流程图的方式进行说明,这些功能模块的划分和设计是以最终实现《软件需求分析说明书》的功能描述的要求为原则的;它将作为项目验收时重要的标准和依据。
软件开发概要设计说明书模板

软件开发概要设计说明书模板<项目名称>概要设计说明书版本历史目录1. 引言 (1)1.1 编写目的 (1)1.2 定义 (1)1.3 参考资料 (1)2. 范围 (1)2.1 系统主要目标 (1)2.2 主要软件需求 (1)2.3 设计约束、限制 (1)3. 软件系统结构设计 (1)3.1 复审数据流、控制流 (1)3.2 软件体系结构 (1)3.2.1 软件程序结构图 (1)3.2.2 模块命名规则 (1)3.2.3 模块描述 (1)3.3 功能需求追溯 (2)3.4 复用策略 (2)4. 数据设计 (2)4.1 数据字典复审 (2)4.2 数据项 (2)4.3 数据库结构设计 (2)4.4 数据结构与程序的关系 (3)4.5 文件设计 (3)5. 接口设计 (3)5.1 用户界面设计规则 (3)5.2 内部接口设计 (3)5.3 外部接口设计 (3)6. 出错处理设计 (3)7. 系统维护设计 (3)1. 引言1.1 编写目的说明编写这份概要设计说明书的目的,并指出预期的读者。
1.2 定义列出文件中用到的专门术语的定义和外文首字母的原词组。
1.3 参考资料列出用的着的参考资料,如:本项目的经核准的计划任务书或合同,上级机关的批文。
属于本项目的其他已发表的文件本文件中各处引用的文件、资料、包括所需用到的软件开发标准。
2. 范围对《需求规格说明书》进行复审,如有变更需要在本节进行说明。
以下内容描述软件概要设计的整体范围,其主要信息来自于《需求规格说明书》。
2.1 系统主要目标2.2 主要软件需求2.3 设计约束、限制3. 软件系统结构设计3.1 复审数据流、控制流复审需求分析阶段对软件的功能需求的描述(如系统的DFD图和IDEF0图)是否合理和精化。
否则,应在本节进行进一步分解和精化。
3.2 软件体系结构通过变换映射(如基于DFD或基于IDEF0 的结构设计),并采用适当的优化准则进行软件结构的优化。
软件设计说明书(5篇范例)

软件设计说明书(5篇范例)第一篇:软件设计说明书设计说明书引言水利方向一直是国家十分重视且投入巨大的方向,它关乎方方面面。
百姓生命安全、水资源的利用、农业的灌溉等等,都与其息息相关,但是,正因为它的无处不在,导致如果使用传统的手段,将需要消耗过多的人力,效率极其低下,甚至是不可完成的,所以,水利也需要更加现代化的手段去完成预期的目标,水利自动化就是为了这一目的而提出来的。
水利自动化可以大大提高数据测量的准确度和控制的可靠性,提高效率,降低劳动强度,充分利用现有设备,从而对于当地水利单位和水利公司均能带来可观的经济和社会收益。
1.1 编写目的a.编写本说明书的目的在于阐明用户的要求的,描述出系统的需求模型、功能和性能要求以及其他约定,为后期的软件设计等工作提供依据。
b.本说明书的预期读者为用户、系统设计员及其他开发人员和相关审核检测人员。
1.2 背景本项目的任务提出者及开发者是北京恒宇伟业科技发展有限公司生产部开发小组:项目负责人:硬件设计工程师:系统分析员:系统设计员:编码员:软件测试员:用户为各地方招标业主单位,该软件在WINDOW7系统下,在IAR FOR MSP430环境下完成开发,1.3 定义RTU:远程终端单元。
水文监测系统:是指用于对各类水文要素实施采集、传输、处理的总体。
1.4 参考资料水文检测数据通信规约(SL651-2014)2 设计总体2.1 需求规定本软件系统的各种用户是唯一的参与者,参与者通过使用事件与系统进行交互,所有的使用事件综合起来即构成了用户的功能需求。
本系统通过用户操作键盘操作及显示屏显示交互设定相关系统、通讯、传感器参数,查看历史数据和系统运行状态。
2.2运行环境本软件属于工业级产品设备运行系统,运行在基于MSP430F5438A CPU芯片的自助设计的电路板上。
部分操作依托于外部传感器设备。
2.3 基本设计概念和处理流程2.4 结构初始化函数流程图Main函数流程图数据发送流程图水位数据采集流程图雨量数据采集流程图数据处理模块流程图输入数据处理模块2.5 功能需求与程序的关系主程序函数main();系统滴答初始化Init_CLK();GPIO口相关映射初始化Init_Port();;UART口相关初始化Init_RSUART();键盘相关初始化Init_Keypad();菜单链表初始化Init_Menu();系统时钟读取RX8025_R();本地网络修复模块NetFix();输入数据处理模块IO_ReportDeal();菜单模块Menu_Ctrl();雨量数据处理模块Msg_RainDDeal();水位数据处理模块Msg_WaterDeal();报文拼组模块Msg_PostDeal();数据发送模块NT_SendMsg();系统参数变更存储模块SysParSave();2.6 人工处理过程用户通过键盘及显示屏,依靠系统菜单,对相关内容进行设置,以达到按照具体需求运行程序获得预期效果的结果。
软件系统概要设计说明书模板

概要设计说明书1.引言1.1编写目的在本机票预定系统项目的前一阶段,也就是需求分析阶段中,已经将系统用户对本系统的需求做了详细的阐述,这些用户需求已经在上一阶段中对航空公司、各旅行社及机场的实地调研中获得,并在需求规格说明书中得到详尽得叙述及阐明。
本阶段已在系统的需求分析的基础上,对机票预定系统做概要设计。
主要解决了实现该系统需求的程序模块设计问题。
包括如何把该系统划分成若干个模块、决定各个模块之间的接口、模块之间传递的信息,以及数据结构、模块结构的设计等。
在以下的概要设计报告中将对在本阶段中对系统所做的所有概要设计进行详细的说明。
在下一阶段的详细设计中,程序设计员可参考此概要设计报告,在概要设计对机票预定系统所做的模块结构设计的基础上,对系统进行详细设计。
在以后的软件测试以及软件维护阶段也可参考此说明书,以便于了解在概要设计过程中所完成的各模块设计结构,或在修改时找出在本阶段设计的不足或错误。
1.2项目背景本项目(机票预定系统)时由<>航空公司委托,由<>负责开发。
机票预定系统将由两部分组成:置于个旅行社定票点的前台客户程序,以及置于1.3.1 专门术语SQL SERVER: 系统服务器所使用的数据库管理系统(DBMS)。
SQL: 一种用于访问查询数据库的语言事务流:数据进入模块后可能有多种路径进行处理。
主键:数据库表中的关键域。
值互不相同。
外部主键:数据库表中与其他表主键关联的域。
ROLLBACK: 数据库的错误恢复机制。
1.3.2 缩写系统:若未特别指出,统指本机票预定系统。
SQL: Structured Query Language(结构化查询语言)。
A TM: Asynchronous Transfer Mode (异步传输模式)。
1.4参考资料以下列出在概要设计过程中所使用到的有关资料:1.机票预定系统项目计划任务书<>航空公司1999/32.机票预定系统项目开发计划《》软件开发小组1999/33.需求规格说明书《》软件开发小组1999/34.用户操作手册(初稿)《》软件开发小组1999/45.软件工程及其应用周苏、王文等天津科学技术出版社1992/16.软件工程张海藩清华大学出版社1990/117.Computer Network A.S.Tanenbaun Prentice Hall 1996/01文档所采用的标准是参照《软件工程导论》沈美明著的“计算机软件开发文档编写指南”。
软件概要设计说明书模板

软件概要设计说明书模板软件概要设计说明书。
一、引言。
软件概要设计说明书是软件开发过程中的重要文档之一,它对软件的整体架构、功能模块、数据流等进行了详细的描述,为软件开发的后续工作提供了重要的参考依据。
本文档旨在对软件的整体设计思路和功能要求进行说明,为软件开发过程中的各个环节提供指导和支持。
二、总体概述。
本软件是一款面向XX领域的XXX软件,旨在解决XXX问题,提供XXX功能。
整体设计采用了XXX技术,包括XXX模块和XXX模块,通过XXX方式实现核心功能,为用户提供便捷、高效的XXX服务。
三、功能概要。
1. 用户管理模块。
用户管理模块包括用户注册、登录、个人信息管理等功能,通过XXX技术实现用户信息的安全存储和管理,保障用户数据的隐私安全。
2. 数据采集模块。
数据采集模块负责对XXX数据进行采集、整理和存储,通过XXX算法实现数据的准确性和完整性,为后续的数据分析提供可靠的数据支持。
3. 数据分析模块。
数据分析模块是本软件的核心功能之一,通过XXX技术对采集到的数据进行分析和挖掘,提供XXX的数据分析报告,帮助用户了解XXX领域的最新动态和趋势。
4. 可视化展示模块。
可视化展示模块将数据分析结果以图表、报表等形式直观展示,为用户提供直观、清晰的数据展示效果,帮助用户更好地理解数据分析结果。
五、运行环境。
本软件的运行环境要求为XXX操作系统,XXX处理器,XXX内存,XXX硬盘空间,XXX显示器分辨率等,确保软件能够在各种硬件设备上稳定运行。
六、接口设计。
本软件与XXX系统进行接口对接,实现数据的共享和互通,确保软件与外部系统的无缝对接和数据交换。
七、安全性设计。
为了保障用户数据的安全和隐私,本软件采用了XXX技术进行数据加密和安全传输,确保用户数据不被恶意攻击和非法获取。
八、性能设计。
本软件在性能设计上采用了XXX技术,通过优化算法和数据处理流程,提高软件的运行效率和响应速度,确保用户能够快速、流畅地使用软件功能。
软件概要设计说明-模板

项目软件概要设计说明书(该文档仅供内部参考)负责单位:研发部门名称协作单位:协作单位名称(如有)作者:研发人员签名批准:研发部门主任签名修改及签收情况记录:**********股份有限公司摘要描述文档的主要内容。
修改历史本模板在格式上有以下的一系列约定:a)用“< >”括起来的内容,是编写指导,在最终的文档中应予以删除。
其它内容应予以保留。
b)如果某章节内容无需填写,而且本模板没有特殊说明的话,则在该章节下写“无”,而不要将该节删除或不填写任何内容。
目录第一篇概述..................................................错误!未定义书签。
1范围...................................................... 错误!未定义书签。
2设计依据.................................................. 错误!未定义书签。
3术语、定义和缩略语 ........................................ 错误!未定义书签。
术语、定义............................................ 错误!未定义书签。
缩略语................................................ 错误!未定义书签。
第二篇系统总体设计..........................................错误!未定义书签。
4系统体系结构.............................................. 错误!未定义书签。
5体系结构概述.............................................. 错误!未定义书签。
6标准化设计................................................ 错误!未定义书签。
软件概要设计说明书三篇

软件概要设计说明书三篇篇一:软件概要设计说明书1引言1.1编写目的本系统概要设计说明书阐述了物联网项目的背景、目标,以及实施的必要性、紧迫性,对本项目物联网系统整体架构设计方案进行了概要描述。
编制本文档的目的在于为物联网项目组成员、XX业务及技术专家论证本项目的架构设计可行性以及审核该项目时提供相关材料。
1.2阅读对象使用者包括参与本项目的管理人员、设计人员、开发人员、测试人员、质量控制人员以及维护人员。
1.3术语和缩略语1.RFID:射频识别技术(Radio Frequency IDentification),又称电子标签、无线射频识别,是一种通信技术,可通过无线电讯号识别特定目标并读写相关数据,而无需识别系统与特定目标之间建立机械或光学接触。
2.WiMax:WiMax(Worldwide Interoperability for Microwave Access),即全球微波互联接入。
WiMAX也叫802·16无线城域网或802.16。
WiMAX是一项新兴的宽带无线接入技术,能提供面向互联网的高速连接,数据传输距离最远可达50km。
WiMAX还具有QoS保障、传输速率高、业务丰富多样等优点。
WiMAX的技术起点较高,采用了代表未来通信技术发展方向的OFDM/OFDMA、AAS、MIMO等先进技术,随着技术标准的发展,WiMAX逐步实现宽带业务的移动化,而3G则实现移动业务的宽带化,两种网络的融合程度会越来越高。
3.Zigbee:Zigbee是基于IEEE802.15.4标准的低功耗个域网协议。
根据这个协议规定的技术是一种短距离、低功耗的无线通信技术。
这一名称来源于蜜蜂的八字舞,由于蜜蜂(bee)是靠飞翔和“嗡嗡”(zig)地抖动翅膀的“舞蹈”来与同伴传递花粉所在方位心系,也就是说蜜蜂依靠这样的方式构成了群体中的通信网络。
其特点就是近距离、低复杂度、自组织、低功耗、低数据率、低成本。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
软件概要设计报告文档模板1. 引言 (2)1.1编写目的 (2)1.2项目风险 (2)1.3预期读者和阅读建议 (2)1.4参考资料 (2)2. 设计概述 (3)2.1限制和约束 (3)2.2设计原则和设计要求 (3)3. 系统逻辑设计 (4)3.1系统组织设计 (4)3.2系统结构设计 (4)3.2.1 系统特性表 (5)3.2.2 系统特性结构图 (6)3.3系统接口设计 (6)3.3.1 系统接口表 (6)3.3.2 系统接口传输协议说明 (7)3.4系统完整性设计 (7)4. 系统出错处理设计 (8)4.1系统出错处理表 (8)4.2维护处理过程表 (9)5. 技术设计 (10)5.1系统开发技术说明表 (10)5.2开发技术应用说明 (11)6. 数据库设计 (11)7. 词汇表 (11)8. 进度计划 (11)1. 引言引言是对这份软件系统概要设计报告的概览,是为了帮助阅读者了解这份文档是如何编写的,并且应该如何阅读、理解和解释这份文档。
1.1 编写目的说明这份软件系统概要设计报告是基于哪份软件产品需求规格说明书编写的,开发这个软件产品意义、作用、以及最终要达到的意图。
通过这份软件系统概要设计报告详尽说明了该软件产品的软件结构,包括数据库结构和出错处理,从而对该软件产品的结构的描述。
如果这份软件系统概要设计报告只与整个系统的某一部分有关系,那么只定义软件系统概要设计报告中说明的那个部分或子系统。
1.2 项目风险具体说明本软件开发项目的全部风险承担者,以及各自在本阶段所需要承担的主要风险,首要风险承担者包括:●任务提出者;●软件开发者;●产品使用者。
1.3 预期读者和阅读建议列举本软件系统概要设计报告所针对的各种不同的预期读者,例如,可能的读者包括:●用户;●开发人员;●项目经理;●营销人员;●测试人员;●文档编写人员;●等等。
描述文档中,其余部分的内容及其组织结构,并且针对每一类读者提出最适合的文档阅读建议。
1.4 参考资料列举编写软件产品概要设计报告时所用到的参考文献及资料,可能包括:●本项目的合同书;●上级机关有关本项目的批文;●本项目已经批准的计划任务书;●用户界面风格指导;●开发本项目时所要用到的标准;●系统规格需求说明;●使用实例文档;●属于本项目的其它已发表文件;●本软件系统概要设计报告中所引用的文件、资料:●相关软件系统概要设计报告:●等等。
为了方便读者查阅,所有参考资料应该按一定顺排列。
如果可能,每份资料都应该给出:●标题名称;●作者或者合同签约者;●文件编号或者版本号;●发表日期或者签约日期;●出版单位或者资料来源。
2. 设计概述本节描述现有开发条件和需要实现的目标,说明进行概要设计时应该遵循的设计原则和必须采用的设计方法。
2.1 限制和约束简要描述起到限制和约束作用的各种可能存在的条件,例如:●技术条件;●资金状况;●开发环境(包括:工具和平台);●时间限制;●等等。
并且说明在上述条件下,应该实现的系统目标,2.2 设计原则和设计要求描述对本软件系统进行概要设计的原则,通常可以考虑以下几方面的内容:●命名规则;●模块独立性原则:●边界设计原则;●数据库设计规则;●必须的安全措施;●安全性和保密原则;●系统灵活性要求;●系统易操作性要求;●系统可维护性要求;●等等。
3. 系统逻辑设计本节内容主要根据软件产品需求规格说明书和软件产品数据字典建立系统的逻辑模型。
此种模型暂时与系统的物理因素(例如:计算机、数据库管理系统)无关。
它是系统需求与物理实现的中间结构,它的主要结果是建立:系统结构图、系统界面结构图、系统出错处理、以及系统开发技术说明。
说明:如果进行系统设计时尚未编写软件数据字典:应首先参照附录B说明,编写软件数据字典。
在完成软件数据字典后,再进行系统设计。
3.1 系统组织设计系统组织设计通过系统组织表描述本系统由哪些子系统(模块)组成,这些子系统与业务其中:●子系统编号给出本系统中指定子系统的顺序编号。
如果本系统末划分为多个子系统,仅由一个运行模块组成;则本项内容仍需要描述,但是本表内容只有一行。
说明:在一个系统中有可能安装若干个相同的子系统,在这种情况下,应该视为一个子系统,并且对多个安装地点分别进行描述。
如果相同的子系统通过系统设置,实现的业务职能具有明显差异时,应该采用多行进行分别描述,并且在备注中说明其差异所在。
●子系统英文名称给出本子系统的英文名称,该名称是在应用软件中实际使用的可执行文件名称,必须能够说明该子系统的特点。
若本系统中只有一个子系统,则本项内容仍需要描述,但是本表内容只有一行。
●子系统中文名称给出本子系统的中文名称,该名称必须能够说明该子系统的特点。
若本系统中只有一个子系统,则本项内容仍需要描述,但是本表内容只有一行。
●业务职能描述该子系统完成的核心业务。
●安装地点描述该子系统实际安装的部门、或者某个具体地点。
●备注针对该子系统,需要说明的其它有关问题。
3.2 系统结构设计本节将对系统特性作较为详细的描述,并给出系统特性结构图。
3.2.1 系统特性表系统特性是系统中完成某项具体操作的基本单元,它由入口参数,出口参数以及处理过程三部分组成。
系统特性可以具有操作界面,也可以没有操作界面;可以被其它操作界面、或者系统特性调用,也可以调用其它操作界面、非操作界面、或者系统特性;但是不允许递归调用(调用自己),包括间接递归调用。
当系统由多个子系统(模块)组成时,每个子系统分别使用一张系统特性表进行描述。
系统特性表的格式如下:其中●子系统编号含义同上。
●子系统英文名称含义同上。
●子系统中文名称含义同上。
●特性编号整个系统所有特性的统一编号。
●系统特性英文名称系统特性的英文正式名称,将来用于软件开发中,必须符合命名规范。
●系统特性中文名称系统特性的中文正式名称,来源于需求规格说明书中,系统特性一节中的有关描述。
●操作功能是指该特性实际完成的操作说明。
●调用对象是指调用该系统特性的系统对象,这里的系统对象可以是系统特性、也可以是操作界面。
●被调用对象是指被该系统特性调用的系统对象,这里的系统对象可以是系统特性、也可以是操作界面。
说明:某些较低层的系统特性,可能不存在被调用对象。
●备注描述与该系统特性有关的其它注意事项。
●说明描述与该系统特性表有关的其它注意事项。
3.2.2 系统特性结构图系统特性结构图给出系统特性在逻辑层面上相互之间的关系,其主要依据来源于需求规格说明书中,系统特性一节中的有关描述。
如果系统划分为多个子系统,应分别给出系统与子系统、以及各个子系统与系统特性的结构图。
绘制系统与子系统结构图时,一般不需要描绘出系统特性,如果确有必要,尽可能只画出第一层系统特性。
绘制子系统与系统特性结构图时,通常也不需要描绘出第二层系统特性,如果确有必要可以画出,但是尽可能不要画出第三层系统特性。
3.3 系统接口设计系统接口是一种非可视的系统界面,在多数情况下,它对用户是透明的。
本节将对系统接口作较为详细的描述,并给出接口说明清单。
3.3.1 系统接口表接口作为系统的一种输入/输出形式,分为网络接口、数据库接口、RS-232串行通讯接口、IEEE—485串行总线接口、并行I/O接口等等多种类型。
对于一些为可视界面服务的接口,例如:打印机接口、显示器接口等,因为这类接口对应用软件是透明的,所以不在本节描述范围内。
当系统由多个子系统(模块)组成时,每个子系统分别使用一张系统接口表进行描述。
系●子系统编号含义同上。
●子系统英文名称含义同上。
●子系统中文名称含义同上。
●接口编号整个系统所有接口的统一编号。
●接口名称系统接口的正式名称,必须符合通常习惯。
●接口类型指出该接口所传输的数据在该模块中起到的作用。
●接口性质指出该接口在通讯中起到的作用,这里的作用可以是:⏹输入;⏹输出;⏹双向。
●接口速率指出该接口的传输速率。
如果该接口依赖于其它通讯方式,那么传输速率将不高于它所依赖的其它通讯方式的速率。
●接口协议给出该接口实际使用的通讯协议。
●相关对象给出直接使用本接口的系统对象,这里的系统对象,可以是操作界面,也可以是系统特性。
●备注描述与该系统接口有关的其它注意事项。
●说明描述与该系统接口表有关的其它注意事项。
3.3.2 系统接口传输协议说明逐项详细描述系统接口表中所列出各个系统接口使用的传输协议,以及其它相关内容,例如:驱动程序、动态连接库、等等。
3.4 系统完整性设计描述系统对象(数据元、数据类),所受到的逻辑约束关系。
当系统由多个子系统(模块)组成时,每个子系统应分别使用一张系统完整性约束表进行描述。
系统完整性约束表的格式如下:其中:●子系统编号含义同上。
●子系统英文名称含义同上。
●子系统中文名称含义同上。
●约束编号整个系统所有约束的统一编号。
●完整性名称系统完整性约束的正式名称,必须符合通常习惯。
●相对对象名完整性约束中的相关对象(数据元和数据类)。
●约束表达式用一阶逻辑表达式表达的约束方程式。
●备注描述与该系统完整性约束有关的其它注意事项。
●说明描述与该系统完整性约束表有关的其它注意事项。
4. 系统出错处理设计本节描述系统发生外界及内在错误时,所提供的错误信息及处理方法,它包括系统出错处理表及维护处理过程表。
4.1 系统出错处理表本表给出有关出错处理的产生原因、提示信息、以及建议处理方法。
当系统由多个子系统(模块)组成时,每个子系统分别使用一张系统出错处理表进行描述。
系统出错处理表的格式如下:其中:●子系统编号含义同上。
●子系统英文名称含义同上。
●子系统中文名称含义同上。
●错误编号整个系统所有错误的统一编号。
●错误名称错误的正式名称,该名称应该是常用的,并且为人们所普遍接受的。
●错误原因对该错误产生原因的解释与说明。
●错误信息产生该错误时,向用户发出的提示信息。
●处理方式对该错误处理的一种建议,此项允许缺省。
●备注描述与该系统错误有关的其它注意事项。
●说明描述与该系统错误表有关的其它注意事项。
4.2 维护处理过程表系统出错时,将调用维护处理过程对错误进行处理,有关维护处理过程的各项内容由维护处理过程表进行描述。
当系统有多个子系统(模块)组成时,每个子系统分别使用一张维护处理过程表进行描其中:●子系统编号含义同上。
●子系统英文名称含义同上。
●子系统中文名称含义同上。
●错误编号含义同上。
●处理过程英文名称系统维护处理过程的英文正式名称,将来用于软件开发中,必须符合命名规范。
●处理过程中文名称系统维护处理过程的中文正式名称,是系统维护处理过程英文名称的中文说明。
●处理功能描述本维护处理过程对错误的处理方式。
由于一个维护处理过程有可能具有对多个错误进行处理的能力,因此该处理功能必须是针对本项错误编号的。
●入口参数进行本项错误处理时,赋给维护处理过程的入口参数。