47 lines
1.9 KiB
Markdown
47 lines
1.9 KiB
Markdown
|
---
|
|||
|
|
name: 接口数据元素特征描述规范
|
|||
|
|
description: 为涉及数据交换的接口（如接口设计文档、数据交换规范或通信协议）提供标准化的数据元素特征描述清单。当接口涉及具体数据传输且需详细说明每个数据项的属性时使用本技能。
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# 接口数据元素特征描述规范
|
|||
|
|
|
|||
|
|
## 何时使用
|
|||
|
|
- 接口涉及数据交换（如系统间通信、API 设计、数据共享）
|
|||
|
|
- 需要为接口中的每个数据元素提供完整、明确的技术与业务描述
|
|||
|
|
- 文档类型包括：接口设计文档、数据交换规范、通信协议
|
|||
|
|
- 不适用于仅描述功能逻辑而不包含具体数据字段的高层接口
|
|||
|
|
|
|||
|
|
## 执行步骤
|
|||
|
|
对每个在接口中被提供、存储、发送、访问或接收的数据元素，按以下结构进行描述：
|
|||
|
|
|
|||
|
|
1. **名称/标识符**
|
|||
|
|
- 唯一标识符
|
|||
|
|
- 非技术名称（自然语言名称）
|
|||
|
|
- 数据元素名称（优先采用行业或组织内标准化名称）
|
|||
|
|
- 技术名称（如变量名、数据库字段名）
|
|||
|
|
- 缩写名或同义名
|
|||
|
|
|
|||
|
|
2. **数据类型**（如字母、数字、整数、布尔值、日期时间等）
|
|||
|
|
|
|||
|
|
3. **大小和格式**（如字符串最大长度、日期格式 YYYY-MM-DD）
|
|||
|
|
|
|||
|
|
4. **计量单位**（如 m、kg、秒；若适用）
|
|||
|
|
|
|||
|
|
5. **取值范围或枚举值**（如 0~99、['active', 'inactive']）
|
|||
|
|
|
|||
|
|
6. **准确度与精度**
|
|||
|
|
- 准确度：数据反映真实值的程度
|
|||
|
|
- 精度：有效数字位数或小数位数
|
|||
|
|
|
|||
|
|
7. **业务与操作约束**
|
|||
|
|
- 优先级、时序要求、更新频率
|
|||
|
|
- 容量限制、序列依赖
|
|||
|
|
- 是否可更新、适用的业务规则
|
|||
|
|
|
|||
|
|
8. **保密性约束**（如是否包含敏感信息、是否需加密传输）
|
|||
|
|
|
|||
|
|
9. **来源与接收者**
|
|||
|
|
- 来源：创建或发送该数据元素的实体
|
|||
|
|
- 接收者：使用或接收该数据元素的实体
|
|||
|
|
|
|||
|
|
确保所有描述清晰、无歧义，并尽可能复用已有标准命名体系。
|