SuperAPI AI 工具集

high-level-design

编程与开发

查看项目

更新于 10-16 07:31

技能介绍

用途

High-Level Design 用于从功能需求出发,设计模块化的高层架构,并为每个模块产出设计文档。它适合在设计一个新系统、从功能需求推导架构、或需要模块化拆分与集成契约定义的场景。

主要能力

  • 读取功能需求文件(若 $ARGUMENTS 为文件路径则读取该文件;若为空或无效则先向用户索取路径)。
  • 将功能需求用自己的话复述,并组织为内聚的功能领域。
  • 使用 DDD 子域(core / supporting / generic)对领域分类,以确定波动性与投入设计精力的地方,并以表格形式呈现给用户确认。
  • 基于 Balanced Coupling 模型识别高层模块、职责与集成关系。
  • 从集成强度、距离、波动性三个维度评估每个集成,并应用平衡规则:BALANCE = (STRENGTH XOR DISTANCE) OR NOT VOLATILITY。
  • 标记不平衡耦合:高强度+高距离(分布式单体风险),或低强度+低距离(低内聚/大泥球风险),并给出重新平衡的具体建议。
  • 为每个模块生成 docs/design/{module-name}/design.md,包含功能职责、封装知识、子域分类、集成契约、变更向量。
  • 为每个模块生成 docs/design/{module-name}/tests.md,包含单元测试、集成契约测试、边界测试、行为测试,每个测试含测试名称、场景、预期行为。
  • 生成 docs/design/architecture.md,包含功能需求摘要、模块地图、模块协作方式、耦合评估、设计决策与权衡、未解决风险。
  • 在设计完成后进行模块化自评审,对问题按 Critical / Significant / Minor 分级;若存在 Critical 或 Significant 问题,提出具体调整并更新受影响文档,循环评审直到无 Critical 或 Significant 问题。

使用方式

该技能以分步流程推进,每一步都需要用户明确批准后才能进入下一步。交互遵循以下规则:始终使用 AskUserQuestion 获取输入;一次只问一个问题,不批量提问;优先提供 2-4 个具体选项的多选题;“Other”选项由工具自动提供;使用短标题(最多 12 字符)。若任何步骤出现歧义,会停下来用 AskUserQuestion 向用户澄清,绝不假设。

主要流程:

  1. Step 1 理解需求:阅读需求文件,复述并组织功能领域;列清所有不明确、缺失或需假设之处,逐一提问;用 DDD 子域分类并请用户确认;展示完整理解并获取批准。
  2. Step 2 设计模块化架构:识别模块、职责与集成;分类波动性;评估三个耦合维度;应用平衡规则;标记不平衡耦合并给出再平衡建议;展示耦合评估表并获取批准。
  3. Step 3 编写模块设计文档:依据已批准架构,为每个模块编写 design.md,无需逐个批准,写完后整体提交评审并迭代至批准。
  4. Step 4 编写模块测试规格:为每个模块编写 tests.md,无需批准,由已批准设计直接推导。
  5. Step 5 编写架构文档:生成 architecture.md,无需批准,综合已批准的模块设计。
  6. Step 6 模块化评审:审查集成,映射共享知识,评估三维度,应用平衡规则,标记不平衡且波动的集成,按严重程度分级;Critical 或 Significant 问题与用户确认后更新文档并重复评审;Minor 问题记录在架构文档的“Unresolved Risks”中但不阻塞完成。

适用场景

  • 设计新系统的高层架构。
  • 从功能需求推导模块边界与集成契约。
  • 需要对模块进行波动性分类并决定设计投入。
  • 需要为模块编写可执行的设计文档与测试规格。

限制与约束

  • 绝不假设:任何不清楚之处先询问用户再继续。
  • 文档需可执行:设计文档应让开发者有足够上下文开始实现,测试规格应让开发者有足够上下文开始写测试。
  • 不得建议“把所有东西都解耦”,因为那忽略强度与距离之间的平衡。
  • 不得仅用单一维度评估耦合,必须同时考虑强度、距离、波动性。
  • 需区分本质波动与偶然波动:提交频率高可能意味着设计不佳(偶然波动),而非领域波动。
  • 需考虑距离的组织维度:相同代码结构 + 不同团队 = 更高的有效距离。
  • 每条建议都要以模型为依据,引用具体维度与原则。
  • 每一步都需要用户批准。

暂未提供

关于收费、价格、平台支持、运行环境要求、安装命令及性能指标等信息,资料中暂未提供。