软件接口说明文档怎么写

1 引言

1．1编写目的

说明编写这份详细设计说明书的目的，指出预期的读者。

1．2背景

说明：

a．待开发软件系统的名称；

b．本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。

1．3定义

列出本文件中用到专门术语的定义和外文首字母组词的原词组。

1．4参考资料

列出有关的参考资料，如：

a．本项目的经核准的计划任务书或合同、上级机关的批文；

b．属于本项目的其他已发表的文件；

c．本文件中各处引用到的文件资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。

2 程序系统的结构

用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间 的层次结构关系。

3 程序1（标识符）设计说明

从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。 对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层 模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。

3．1程序描述

给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如 是常驻内存还是非常驻？是否子程序？是可重人的还是不可重人的？有无覆盖要求？是顺序处理还是并发 处理卜…．．等）。

3．2功能

说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。

3．3性能

说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。

3．4输人项

给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。 数量和频度、输入媒体、输入数据的来源和安全保密条件等等。

3． 5输出项

给出对每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范围，输出的形式、 数量和频度，输出媒体、对输出图形及符号的说明、安全保密条件等等。

3．6算法

详细说明本程序所选用的算法，具体的计算公式和计算步骤。

3．7流程逻辑

用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流程。

3．8接口

用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数据结构（数据库、数据文卷）。

3．9存储分配

根据需要，说明本程序的存储分配。

3．10注释设计

说明准备在本程序中安排的注释，如：

a． 加在模块首部的注释；

b．加在各分枝点处的注释； 对各变量的功能、范围、缺省条件等所加的注释；

d．对使用的逻辑所加的注释等等。

3．11限制条件

说明本程序运行中所受到的限制条件。

3．12测试计划

说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。

3．13尚未解决的问题

说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。

4 程序2（标识符）设计说明

用类似3的方式，说明第2个程序乃至第N个程序的设计考虑。

1.0概述 这部分提供对整个设计文档的概述。描述了所有数据，结构，接口和软件构件级别的设计。

1.1 目标和对象 描述软件对象的所有目标。

1.2 陈述范围 软件描述。主要输入，过程功能，输出的描述，不考虑详细细节。

1.3 软件内容 软件被置于商业或者产品线中，讨论相关的战略问题。目的是让读者能够对“宏图”有所了解。

1.4 主要系统参数 任何商务软件或者产品线都包含软件规定、设计、实现和测试的说明和规范。

2.0 数据设计 描述所有数据结构包括内部变量，全局变量和临时数据结构。

2.1 内部软件数据结构 描述软件内部的构件之间的数据传输的结构。

2.2 全局数据结构 描述主要部分的数据结构。

2.3 临时数据结构 为临时应用而生成的文件的描述。

2.4 数据库描述 作为应用程序的一部分，描述数据库结构。

3.0 结构化和构件级别设计 描述程序结构。

3.1 程序结构 详细描述应用程序所选定的程序结构。

3.1.1 结构图 图形化描述结构。

3.1.2 选择性 讨论其它可供考虑的结构。选定3.1.1中结构类型的原因。

3.2 构件描述 详细描述结构中的每个软件构件。

3.2.1 构件过程叙述(PSPEC) 描述构件的过程。

3.2.2 构件接口描述 详细描述构件的输入和输出。

3.2.3 构件执行细节 每个构件的详细演算描述。

3.2.3.1 接口描述

3.2.3.2 演算模型(e.g., PDL)

3.2.3.3 规范/限制 ]

3.2.3.4 本地数据结构

3.2.3.5 在3.2.3.6设计中包含的执行结果

3.3 软件接口描述 软件对外界的接口描述

3.3.1机器对外接口 与其他机器或者设备的接口描述。

3.3.2系统对外接口 对其它系统、产品和网络的接口描述。

3.3.3与人的接口 概述软件与任何人的界面。

4.0 用户界面设计 描述软件的用户界面设计。

4.1 描述用户界面 详细描述用户界面，包括屏幕显示图标、图片或者类型。

4.1.1 屏幕图片 从用户角度描述界面。

4.1.2 对象和 *** 作 所有屏幕对象和 *** 作的定义。

4.2 界面设计规范 用户界面的设计和实现的规范和标准。

4.3 可见构件 实现的GUI可见构件说明。

4.4 UIDS描述 用户界面开发系统描述。

5.0约束、限制和系统参数 会影响软件的规格说明、设计和实现的特殊事件。

6.0测试标准 测试策略和预备测试用例描述。

6.1 测试的类别 规定实施测试的类别，包括尽量详细的描述。这里是针对黑盒测试现象的描述。

6.2期待软件反馈 测试期待的结果描述。

6.3执行界线 特殊执行需要的说明。

6.4 重要构件确认 决定性构件或者需要特殊注意的构件的测试确认。

7.0附录 设计说明的补充信息。

7.1系统可跟踪矩阵 一个定期回归系统规格跟踪软件需求的矩阵。

7.2 产品战略 如果规格说明书是为一个产品设计的，描述相关的产品战略。

7.3 使用分析算法 描述所有分析活动所使用到的分析算法。

7.4 补充信息 (如果有需要特别说明的)

---