agentsclimarketplace

Design an interface

Skill BlueprintOS/analysis-to-delivery/skills/orchestration/development/design-an-interface

通用需求到开发设计工作流 — 26 个独立可组合 skill,跨行业(医药/SaaS/移动),3 个完整示例,5 个 CI workflow,Mermaid/Drawio 流程图工具链,VSCode 集成

Install
npx -y skills add BlueprintOS/analysis-to-delivery --skill design-an-interface

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 24 stars24 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

设计接口契约 — 来自 superpowers 体系。本 skill 是桥接层,完整纪律见 <SUPERPOWERS_SKILL_ROOT>/design-an-interface/。

SKILL.md

2.4 KB, as published. Nobody here has run it

Design-an-Interface(桥接到 superpowers)

Contract

  • Inputs: design spec, domain constraints, integration points
  • Outputs: interface contract document
  • Gates: interface is testable and accepted by caller/implementer
  • Required disciplines: stage-gate
  • Next: /domain-modeling or /writing-plans

本仓库不维护此 skill 的内容。完整纪律请读: <SUPERPOWERS_SKILL_ROOT>/design-an-interface/SKILL.md

何时调

  • brainstorming 之后,writing-plans 之前
  • 需要把功能拆成可测试的接口

衔接点

  • 产出:接口契约文档
  • 下一步:/domain-modeling 或 /writing-plans
  • 门控:disciplines/stage-gate 第 2 层

降级方案(superpowers 未装时)

如果 <SUPERPOWERS_SKILL_ROOT>/design-an-interface/ 不存在,按以下 4 步产出接口契约:

1. 列举调用方与实现方

  • 调用方是谁?(controller / 巴枪 / 第三方系统)
  • 实现方是谁?(哪个 service / 模块)
  • 触发场景有哪些?(主动调用 / 事件回调 / 定时)

2. 写接口契约表

每个接口必须含 5 列:

列含义例子
Name方法/路径名POST /api/v1/asn/receive
Input入参 schema{tcAsnId, lpnList[]}
Output出参 schema{receivedQty, exceptionList[]}
Errors错误码字典E_ASN_NOT_FOUND(40401)
Pre/Post前置/后置条件前置:ASN 状态=10;后置:状态=30

3. 验收契约

  • 可测试性:每个契约都对应 1 个测试用例(契约层用)
  • 错误码对齐:与全局 09-QA审计报告 的错误码字典一致
  • 联调:与调用方对齐字段名 / 类型,字段名严禁猜测(走 disciplines/no-field-guessing)

4. 输出 + 签字

写到 docs/superpowers/specs/<topic>-interface.md,末尾 ## Sign-off 等用户白名单签字(4 句之一)。

最小纪律摘要

  • 契约是合同:写下来就不准改,改了要重新签字
  • 错误码全局唯一:不复用业务字段名当错误码
  • Pre/Post 必须:只写 Input/Output = 验收没边界
  • 联调不靠人脑:调用方拿到契约文档就能写 Mock

安装提示

npx skills@latest add obra/superpowers-design-an-interface

Keep looking

Skills are one crate of 328,083. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.