SuperAPI AI 工具集

software-design

编程与开发

查看项目

更新于 10-16 04:39

技能介绍

用途

software-design 是一个软件设计阶段的技能,目标是将需求转化为可执行的模块设计方案,明确模块边界、接口和 UI 交互。它适用于需求已确认、需要进入模块化设计并产出设计文档的场景。

依赖规范

该技能依赖以下规范文件:

  • ../rules/review-base.md
  • ../rules/git-workflow.md
  • ../rules/project-structure.md
  • frontend-design.md
  • backend-design.md

输入

需求文档:需求清单 + 范围边界说明,或对话上下文。

主要能力与使用方式

技能按步骤执行,每个步骤先输出标题,再输出结果:

  1. 分批设计:将设计拆成批次,每批次完成模块边界、接口和交互流程,与开发者 review 确认,记录设计决策。
  2. 文档拆分:根据项目架构,按 frontend-design 和 backend-design 规范分别输出对应的设计文档。
  3. 模块依赖:所有模块设计完成后,标注模块间的依赖关系。
  4. 写入文档:每个模块单独一个文件,创建入口文档引用所有设计文件(路径遵守 project-structure 文档存放规范)。
  5. 执行 review:遵守 review-base,通过后才进入下一步。

输出

  • 模块划分方案:职责、边界
  • 模块依赖关系:标注模块间的依赖,无依赖的模块不需要列出
  • 前端设计文档:按 frontend-design 规范输出(涉及前端时)
  • 后端设计文档:按 backend-design 规范输出(涉及后端时)

Review 检查清单

  • 模块职责:单一,边界清晰,无职责重叠
  • 前端设计:符合 frontend-design 规范(涉及前端时)
  • 后端设计:符合 backend-design 规范(涉及后端时)
  • 模块依赖:依赖关系已标注,无循环依赖
  • 需求覆盖:覆盖所有已确认的需求,无遗漏
  • 公共模块:已识别,无重复设计
  • 敏感信息:设计文档中不包含真实密码、密钥、token 等敏感信息,使用占位符代替

阶段结束

下一阶段:dev-planning,并遵循 ../rules/stage-gate.md。

限制

具体安装方式、收费模式、支持平台等信息暂未提供。