SuperAPI AI 工具集

design-it-twice

编程与开发

查看项目

更新于 10-16 06:27

技能介绍

用途

Design It Twice 是一个用于软件接口设计的思维流程技能。它的出发点是:你的第一个想法很少是最好的。在编写任何实现之前,先确定接口。该技能适用于设计新的模块、包、类、API 或 CLI 的场景。

主要能力

该技能提供了一套结构化的设计流程:

  1. 陈述需求:写下调用者在常见情况下必须做什么,以 2–4 个具体调用点表示。
  2. 草拟 2–3 个截然不同的接口:只写签名加一行注释,不写函数体。如果只有一个设计看起来合理,仍然要刻意草拟一个不同的设计,因为它的弱点能带来启发。对于大型设计,可以每个备选方案并行运行一个子代理。
  3. 为每个备选方案写出常见场景的调用点:让调用者写额外胶水代码的设计会落败。
  4. 比较,按最重要的标准优先:常见场景的易用性(更高层代码保持简单)、接口简洁度(更少的方法和概念,同等能力)、深度(隐藏了多少)、通用性(适度通用,功能服务于当前需求但接口不绑定于它们)、是否允许高效实现。
  5. 综合:胜出者往往是混合体。如果每个选项都很别扭,把共同的别扭转化为需求并重新设计。例如,基于行和基于字符的文本 API 都迫使调用者做文本操作,这引出了基于范围的 API。
  6. 当实现非平凡时,对实现重复该流程:对于实现,权衡简洁性和性能。

该技能还提供了一些有用的问题:覆盖所有当前需求的最简接口是什么?每个方法会在多少种情况下被使用?只在一个地方使用的方法是一个危险信号。是否易于满足当前需求而不需要大量调用者代码?

使用方式

该技能定义了输出格式:

  • Alternatives: A — <名称>:签名、常见场景调用点、优缺点;B — ...;C — ...
  • Decision: <选定或混合> — 为什么,用 2–3 行说明
  • Interface: 最终签名 + 接口注释(参见 comments-first)

然后停止,或者如果用户要求则实现。开发的单位是抽象,而不是功能:现在设计整个核心接口,而不是一次一个测试地增长它。TDD 在选定的抽象内部仍然可行,修复 bug 时先写一个失败的测试。

适用场景

适用于需要设计新模块、包、类、API 或 CLI 接口的软件开发场景,尤其适合希望避免第一直觉设计缺陷、追求更优接口抽象的开发者。

限制

资料中未提供关于该技能的具体平台限制、收费信息、价格或效果保证。该技能描述为一种设计流程,实际效果取决于使用者的具体应用。