34 lines
1.6 KiB
Markdown
34 lines
1.6 KiB
Markdown
|
---
|
||
|
|
name: 接口标识与接口图设计
|
||
|
|
description: 为包含多个接口的系统或软件配置项分配唯一标识符并绘制接口图，以清晰表达接口实体及其关系。当文档中存在两个或以上接口、需进行正式接口设计或系统集成时使用本技能。
|
||
|
|
---
|
||
|
|
|
||
|
|
# 接口标识与接口图设计
|
||
|
|
|
||
|
|
## 何时使用
|
||
|
|
- 文档中包含多个接口
|
||
|
|
- 需要区分不同接口实体（如系统、配置项、用户、外部系统）
|
||
|
|
- 正在编写接口设计文档或进行系统集成工作
|
||
|
|
- 接口涉及固定特性或正在开发/修改的实体
|
||
|
|
|
||
|
|
> **不适用于**：单一简单接口且无需正式文档的情况。
|
||
|
|
|
||
|
|
## 执行步骤
|
||
|
|
1. **分配唯一标识符**：为每个已识别的接口分配项目内唯一的标识符（字符串格式）。
|
||
|
|
2. **标识接口实体**：对每个接口关联的实体（系统、配置项、用户等），明确提供以下信息：
|
||
|
|
- 名称
|
||
|
|
- 编号
|
||
|
|
- 版本
|
||
|
|
- 相关文档引用
|
||
|
|
3. **说明实体状态**：在标识中明确指出：
|
||
|
|
- 哪些实体具有固定的接口特性（并列出其接口需求）
|
||
|
|
- 哪些实体正在被开发或修改（这些实体应已有独立的接口需求）
|
||
|
|
4. **绘制接口图**：适当时，使用一个或多个接口图描述接口结构。
|
||
|
|
5. **确保图示清晰**：接口图必须清晰展示接口实体之间的关系和数据流向。
|
||
|
|
|
||
|
|
## 输出结果
|
||
|
|
每个接口均具备：
|
||
|
|
- 项目唯一的标识符
|
||
|
|
- 清晰的实体信息（名称、编号、版本、文档引用）
|
||
|
|
- 状态说明（固定特性或开发中）
|
||
|
|
- 对应的接口图（如适用）
|