<项目名称>

接口设计

版本 <1.0>

[注:以下提供的模板用于 Sina Unified Process。其中包括用方括号括起来并以蓝色斜体(样式=InfoBlue)显示的文本,它们用于向作者提供指导,在发布此文档之前应该将其删除。按此样式输入的段落将被自动设置为普通样式(样式=Body Text)。]

[要定制 Microsoft Word 中的自动字段(选中时显示灰色背景),请选择 File>Properties,然后将 Title、Subject 和 Company 等字段替换为此文档的相应信息。关闭该对话框后,通过选择 Edit>Select All(或 Ctrl-A)并按 F9,或只是在字段上单击并按 F9,可以在整个文档中更新自动字段。对于页眉和页脚,这一操作必须单独进行。按 Alt-F9,将在显示字段名称和字段内容之间切换。有关字段处理的详细信息,请参见 Word 帮助。]


日期

版本

说明

作者

<日/月/年>

<x.x>

<详细信息>

<姓名>


接口设计

1. 简介

[接口设计的简介应提供整个文档的概述。它应包括此设计指南的目的、范围、定义、首字母缩写词、缩略语、参考资料和概述。]

1.1. 目的

1.2. 范围

[简要说明此接口设计的适用对象;此文档所影响的对象。]

1.3. 定义、首字母缩写词和缩略语

[本小节应提供正确理解此概要设计所需的全部术语、首字母缩写词和缩略语的定义。这些信息可以通过引用项目词汇表来提供。]

1.4. 参考资料

[本小节应完整地列出此概要设计中其他部分所引用的任何文档。每个文档应标有标题、报告号(如果适用)、日期和出版单位。本节最终可能会分为若干个小节:外部文档与内部文档,或政府文档与非政府文档等。列出可从中获取这些参考资料的来源。这些信息可以通过引用附录或其他文档来提供。]

1.5. 概述

[本小节应说明此接口设计中其他部分所包含的内容,并解释文档的组织方式。]

2. 接口设计

2.1. 接口一

接口标识符

[接口标识符为该接口的统一标识,如函数名、类名、方法名等]

所属子系统

[所有接口均为某个子系统或模块暴露给外界、供外界与该子系统内部通信的入口,因此指明该接口所属的子系统是必需的]

接口描述

[给予本接口一个简明清晰地描述是文档与阅读者能够正确的理解本接口的功能及适用范围]

接口参数

[指明调用本接口时所需提供的参数或数据]

接口返回值

[指明本接口所返回的数据类型,如果接口返回的是properties、xml等类型的数据文件则说明数据文件的规范格式]

WordToMoin/DemoInterfaceDesign (last edited 2009-12-25 07:08:31 by localhost)