SuperAPI AI 工具集

design-doc

设计与创作

查看项目

更新于 10-16 03:14

技能介绍

用途:在实现前,针对不清晰或重要的架构决策撰写简短设计文档,尤其适用于决策代价高、难以逆转或跨模块的情况。

主要能力与写法:先阅读需求说明及关联文档、代码或计划;仅在缺失事实会改变设计时,一次问一个问题并给出推荐答案。按模板写出 docs/<design-slug>/design.md,篇幅 1-3 页,不适用的小节可省略。模板含标题、状态(Draft/In review/Approved)、作者与日期,以及 Summary、Goals、Non-goals、Constraints、Proposed design、Alternatives and tradeoffs、Risks、Rollout、Open questions、Decision 等小节。

规则:让设计选择与权衡便于评审;聚焦代码日后无法解释的决策;除非确切形态是关键,否则不复制完整 schema、API 或代码;Status 留为 Draft、Decision 留空,由评审阶段填写。

限制:写完即停止,在人工确认前不得继续进入 spec、plan 或实现阶段。

适用场景:架构决策评审、跨模块改动前置设计。费用、平台要求等资料暂未提供。