SuperAPI AI 工具集

design-generator

设计与创作

查看项目

更新于 10-15 21:03

技能介绍

用途:从已批准的需求文档(storage/specs/REQ-*.md)生成并验证符合 SOLID 原则的设计文档,是 SDD 工作流 Phase 2 的核心。前提是 Phase 1 需求已批准、已参照 steering/、需求文档存在。

主要能力:设计文档生成(读取需求后由 DesignGenerator.generate() 生成,经 SOLIDValidator 校验 SRP/OCP/LSP/ISP/DIP,并为每个 DES 附加追溯链接);C4 图生成(提取 C4Element 与 C4Relationship,输出 Context/Container/Component 级 Mermaid 图并嵌入设计文档);ADR 管理(创建、状态生命周期 proposed→accepted→deprecated→superseded、全文搜索与索引);设计验证(PatternDetector 检测设计模式、校验 SOLID 合规、发现与需求对应遗漏)。

使用方式:CLI 命令包括 npx musubix design <req-file>、npx musubix design:c4 <file> [--level context|container|component]、npx musubix decision <create|list|get|accept|deprecate|search|index>、npx musubix design:verify <design-file>。脚本有 scripts/generate.sh、scripts/c4.sh、scripts/verify.sh、scripts/decision.sh。设计文档格式为 DES-XXX-NNN 标题、追溯、包名、设计概要、TypeScript 接口或 Mermaid 图、CLI 契约;ADR 格式含状态、日期、Context、Decision、Consequences。

限制与注意:DES 与 REQ 为 N:M 关系,需维护全方向链接;Mermaid classDiagram 的 ? nullable 需与 TypeScript 的 | undefined 一致;ADR 不能直接置为 superseded,必须经 deprecated。质量门要求全部 DES 可追溯、定义 TypeScript 接口、明确 CLI 契约、无 SOLID 违规、关键决策有 ADR。具体收费、平台与效果暂未提供。