接口设计说明(接口设计说明文档)

网友投稿 927 2023-03-04


本篇文章给大家谈谈接口设计说明,以及接口设计说明文档对应的知识点,希望对各位有所帮助,不要忘了收藏本站喔。 今天给各位分享接口设计说明的知识,其中也会对接口设计说明文档进行解释,如果能碰巧解决你现在面临的问题,别忘了关注本站,现在开始吧!

本文目录一览:

接口设计怎么写?

接口设计包括三个方面:一、用户接口用来说明将向用户提供的命令和它们的语法结构,以及软件的回答信息。二、外部接口用来说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。三、内部接口用来说明本系统之内的各个系统元素之间的接口的安排

设计说明书怎么写,应该注意什么?正确格式?

概要设计说明书又可称系统设计说明书,这里所说的系统是指程序系统。编制的目的是说明对程序 系统的设计考虑,包括程序系统的基本处。流程、程序系统的组织结构、模块划分、功能分配、接口设计。 运行设计、数据结构设计和出错处理设计等,为程序的详细设计提供基础。
编制概要设计说明书的内容,要求如下:
11.1引言
11.1. 1编写目的
11.1.2背景
11.1.3定义
11.1.4参考资料
11.2总体设计
11.2.1需求规定
11.2.2运行环境
11.2.3基本设计概念和处理流程
11. 2. 4”结构
11.2.5功能需求与程序的关系
11. 2. 6人工处理过程
11.2.7尚未解决的问题
11.3接口设计
11.31用户接口
11.32外部接口
11.3 3内部接口
11.4运行设计
11. 4. 1运行模块组合
11.4.2运行控制
11.4.3运行时间
11.5系统论据结构设计
11. 5. 1逻辑结构设计要点
11. 5. 2物理结构设计要点
11.5.3数据结构与程序的关系
11. 6系统出错处理设计
11. 6. 1出错信息
11.6.2补救措施
11.6 3系统维护设计
概要设计说明书的编写提示(参考件)
E.1引言
E.1.1编写目的
说明编写这份概要设计说明书的目的,指出预期的读者。
E.1.2背景
说明:
a.待开发软件系统的名称;
b.列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站(中心)。
E.1.3定义
列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
E.1.4参考资料
列出有关的参考文件,如:
a.本项目的经核准的计划任务书或合同,上级机关的批文;
b.属于本项目的其他已发表文件;
c.本文件中各处引用的文件、资料,包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。
E.2总体设计
E.2.1需求规定
说明对本系统的主要的输入输出项目、处理的功能性能要求,详细的说明可参见附录C。
E.2.2运行环境
简要地说明对本系统的运行环境(包括硬件环境和支持环境)的规定,详细说明参见附录C。
E.2.3基本设计概念和处理流程
说明本系统的基本设计概念和处理流程,尽量使用图表的形式。
E.2.4结构
用一览表及框图的形式说明本系统的系统元素(各层模块、子程序、公用程序等)的划分,扼要说明每个系统元素的标识符和功能,分层次地给出各元素之间的控制与被控制关系.
E.2.5功能器求与程序的关系
本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系:
E.2.6人工处理过程
说明在本软件系统的工作过程中不得不包含的人工处理过程(如果有的话)。
E.2.7尚未问决的问题
说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。
E.3 接口设计
E.3.1用户接口
说明将向用户提供的命令和它们的语法结构,以及软件的回答信息。
E.3.2外部接口
说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接 口关系。
E.3.3内部接口
说明本系统之内的各个系统元素之间的接口的安排。
E.4运行设计
E.4.1运行模块组合
说明对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合,说明每种运行所历经的内部模块和支持软件。
E.4.2运行控制
说明每一种外界的运行控制的方式方法和操作步骤。
E.4.3运行时间
说明每种运行模块组合将占用各种资源的时间。
E.5系统数据结构设计
E.5.1逻辑结构设计要点
给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。
E.5.2物理结构设计要点
给出本系统内所使用的每个数据结构中的每个数据项的存储要求,访问方法、存取单位、存取的物理关系(索引、设备、存储区域)、设计考虑和保密条件。
E.5.3数据结构与程序的关系
说明各个数据结构与访问这些数据结构的形式:
E.6系统出错处理设计
E.6.1出错信息
用一览表的方式说朗每种可能的出错或故障情况出现时,系统输出信息的形式、含意及处理方法。
E.6.2补救措施
说明故障出现后可能采取的变通措施,包括:
a.后备技术说明准备采用的后备技术,当原始系统数据万一丢失时启用的副本的建立和启动的技术,例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术;
b.降效技术说明准备采用的后备技术,使用另一个效率稍低的系统或方法来求得所需结果的某些部分,例如一个自动系统的降效技术可以是手工操作和数据的人工记录;
c.恢复及再启动技术说明将使用的恢复再启动技术,使软件从故障点恢复执行或使软件从头开始重新运行的方法。
E.6.3系统维护设计
说明为了系统维护的方便而在程序内部设计中作出的安排,包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。 各个程序之间的对应关系,可采用如下的矩阵图的形式;

结构化分析

「 软件开发方法 」的含义:软件开发过程所遵循的办法和步骤。

软件开发活动的目的:有效地得到一个运行的系统及其支持文档(程序 + 文档),并且满足有关的质量要求(功能需求 + 非功能需求)。

「 软件开发方法学 」的含义: 规则、方法和工具的集成 ,即支持开发也支持以后的演化过程(交付运行后,系统还会变化;或者为了改错,或为了功能的递增)。

结构化方法是一种特定的软件开发方法学/一种系统化的软件开发方法,包括:

就 软件需求分析 而言,结构化分析指的是:系统化地使用 问题域 术语,给出该 问题的模型 (即“系统必须做什么?”的一个估算)。

一个抽象层是由一组确定的术语定义的,为支持需求分析中有关要使用的那些信息的表达,结构化分析方法给出了以下五个术语/符号:

数据流图是一种描述 数据变换 的图形工具,它包含的元素可以是数据流、数据存储、加工、数据源和数据潭等。

数据字典用于定义 数据流 和 数据存储 的结构,并给出构成所给出的数据流和数据存储的各数据项的基本数据类型。

数据字典还引入了一些 逻辑操作符 来定义 数据结构 。

示例:

描述加工“做什么”,即 加工逻辑 ,也包括其它一些与加工有关的信息,如执行条件、优先级、执行频率、出错处理等。

💡 描述一个加工,一般遵循如下模版:

「结构化自然语言」适用于加工的输入数据和输出数据之间的逻辑关系比较 简单 的加工描述。

示例:

「判定表」适用于加工的输入数据和输出数据之间的逻辑关系比较 复杂 的加工描述。

判定表:

示例:

「判定树」适用于加工的输入数据和输出数据之间的逻辑关系比较 复杂 的加工描述。

示例:

💡 顶层数据流图——0层数据流图——1层数据流图——...

「设计」的定义:一种软件开发活动,定义实现需求规约所需的软件结构。

设计目标:依据需求规约,在一个抽象层上建立系统软件模型,包括软件体系结构(数据和程序结构),以及详细的处理算法,产生设计规约说明书。

即: 回答如何解决问题——给出软件解决方案 。

结构化设计分为:

在总体设计层:

第一阶段:初始设计。在对给定的数据流图进行复审和精化的基础上,将其转化为初始的模块结构图。 根据穿越系统边界的数据流初步确定系统与外部的接口 。
第二阶段:精化设计。依据模块“高内聚低耦合”的原则,精化初始的模块结构图,并 设计其中的全局数据结构和每一模块的接口 。
第三阶段:设计复审阶段,(设计人员与综合评审团队)对前两个阶段得到的高层软件结构进行复审,必要时还可能需要对软件结构做一些精化工作。

基于 模块化 原理—— 高内聚、低耦合 ;

模块化的概念和基本原则(略)。

耦合:不同模块之间相互依赖程度的度量。

内聚:一个模块之内各成分之间相互依赖程度的度量。

启发式规则:根据设计准则,从 长期的软件开发实践中,总结出来的规则 。

接口设计的分类:

系统的接口设计(包括用户界面设计及与其他系统的接口设计)是由穿过系统边界的数据流定义的。

在最终的系统中,数据流将成为用户界面中的表单、报表或与其他系统进行交互的文件或通信。

用户界面应具有的特性:可使用性、灵活性、可靠性。

「数据设计」:在设计阶段必须对要存储的数据及其格式进行设计。

文件设计的主要工作: 根据使用要求、处理方式、存储的信息量、数据的活动性以及所提供的设备条件等确定文件类型 ,选择文件媒体,决定文件组织方法,设计文件记录格式,并估算文件的容量。

以下几种情况适合选择 文件存储 :

详细设计的任务:定义每一模块。

详细设计中主要引入了三种动作控制结构(顺序、选择、循环)的术语/符号。

结构化程序设计的概念:设计具有如下结构的程序:

优点:

PDL 不仅可以作为设计工具,而且可作为注释工具,直接插在源程序中间,以保持文档和程序的一致性,提高了文档的质量。

缺点:

优点:

对控制流程的描绘很直观,便于初学者掌握。

缺点:

优点:

优点:支持自顶向下逐步求精的结构化详细设计,并且严格限制了控制从一个处理到另一个处理的转移。

当算法中 包含多重嵌套 的条件选择时,用程序流程图、盒图、PAD图、PDL都不易清楚描述,这时可以 选择判断表来表达复杂的条件组合与应做的动作之间的对应关系 。

判定树是判定表的变种,也能清晰地表达复杂的条件组合与应做的动作之间的对应关系,形式简单,但简洁性不如判定表,数据元素的同一个值往往需要重复写多次,而且越接近树的叶断重复次数越多。

一切系统都是由信息流构成的(其中包含一些必要的数据变换),每一个信息流都有自己的起点数据源,有自己的归宿数据潭,有驱动信息流动的加工,因此所谓信息处理主要表现为 信息的流动 。

结构化方法是一种系统化的软件系统建模方法,从测试的角度看,结构化方法是一种特定的建立验证和确认所需标尺的方法学,包括 结构化分析 和 结构化设计 。

结构化方法的抽象层,包括:

紧紧围绕 自顶向下 、 过程抽象 、 数据抽象 和 模块化 等基本原理/原则,给出了: 完备的符号 、 可操作的过程 和 易于理解的表示工具 。并提供了:控制信息组织复杂性的机制,例如逐层分解,数据打包等,以支持将问题空间的一个问题映射为解空间的一个解。

关于接口设计说明和接口设计说明文档的介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息,记得收藏关注本站。 接口设计说明的介绍就聊到这里吧,感谢你花时间阅读本站内容,更多关于接口设计说明文档、接口设计说明的信息别忘了在本站进行查找喔。

版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:自研api接口网关(api网关开源)
下一篇:利用vue开发一个所谓的数独方法实例
相关文章

 发表评论

暂时没有评论,来抢沙发吧~