AGENT SKILL

design-an-interface

使用并行子智能体为模块生成多个截然不同的接口设计。当用户想设计 API、探索接口选项、比较模块形态,或提到“设计两次”时使用。

License 许可
MIT
最近更新
2026-07-23
Stars
★ 1
Forks
0

01 前言 Front Matter

name
design-an-interface
description
使用并行子智能体为模块生成多个截然不同的接口设计。当用户想设计 API、探索接口选项、比较模块形态,或提到“设计两次”时使用。

02 资源文件 1

03 SKILL.md 正文

设计接口

本技能以《A Philosophy of Software Design》中的“Design It Twice”为依据:你的第一个想法不太可能是最佳方案。先生成多个截然不同的设计,然后进行比较。

工作流

1. 收集需求

开始设计前,先了解:

  • [ ] 该模块解决什么问题?
  • [ ] 调用方是谁?(其他模块、外部用户、测试)
  • [ ] 关键操作有哪些?
  • [ ] 是否存在约束?(性能、兼容性、现有模式)
  • [ ] 哪些内容应当隐藏在内部,哪些应当公开?

询问:“这个模块需要做什么?谁会使用它?”

2. 生成设计(并行子智能体)

使用 Task 工具同时启动 3 个以上的子智能体。每个子智能体都必须提出一种截然不同的方法。

每个子智能体的提示词模板:

为以下内容设计接口:[module description]

需求:[gathered requirements]

此设计的约束:[assign a different constraint to each agent]
- 智能体 1:“尽量减少方法数量——最多以 1–3 个方法为目标”
- 智能体 2:“最大限度提高灵活性——支持多种用例”
- 智能体 3:“针对最常见情况进行优化”
- 智能体 4:“从 [specific paradigm/library] 中汲取灵感”

输出格式:
1. 接口签名(类型/方法)
2. 使用示例(调用方如何使用)
3. 此设计在内部隐藏的内容
4. 此方法的权衡

3. 展示设计

展示每项设计,并包含:

  1. 接口签名——类型、方法、参数
  2. 使用示例——调用方在实践中如何实际使用
  3. 隐藏的内容——保留在内部的复杂度

依次展示各项设计,让用户先理解每种方法,再进行比较。

4. 比较设计

展示所有设计后,从以下方面进行比较:

  • 接口简洁性:方法更少、参数更简单
  • 通用与专用:灵活性与专注度
  • 实现效率:这种形态是否支持高效的内部实现?
  • 深度:小型接口隐藏大量复杂度(好),还是大型接口只有单薄实现(差)
  • 易于正确使用与易于误用

使用文字而不是表格讨论权衡。突出各项设计分歧最大的部分。

5. 综合

最佳设计通常会结合多个选项的洞见。询问:

  • “哪项设计最符合你的主要用例?”
  • “其他设计中是否有值得吸收的元素?”

评估标准

依据《A Philosophy of Software Design》:

接口简洁性:方法更少、参数更简单 = 更容易学习并正确使用。

通用性:无需更改即可处理未来用例。但要警惕过度泛化。

实现效率:接口形态支持高效实现,还是会迫使内部实现变得别扭?

深度:小型接口隐藏大量复杂度 = 深模块(好)。大型接口只有单薄实现 = 浅模块(应避免)。

反模式

  • 不要让子智能体产出相似设计——必须保证截然不同
  • 不要跳过比较——价值来自对比
  • 不要实现——本技能只关注接口形态
  • 不要根据实现工作量进行评估

04 同仓库更多 Skills