SuperAPI AI 工具集

software-architecture

办公与效率

查看项目

更新于 10-15 16:46

技能介绍

用途:为代码库建立可维护的架构文档体系,便于理解系统结构、入口点与关键抽象,并在结构变更后同步更新。

主要能力:以根目录 ARCHITECTURE.md 承载系统总览、C4 Context/Container 图、关键入口点表、关键抽象表、测试概览与细节文档链接;在 docs/*.md 中按组件记录用途、关键文件、关键抽象,并可按需加入架构图、时序图、依赖、测试与配置。图表类型可按需选择:C4 Context/Container 用于总览,C4 Component 用于组件内部结构,Flowchart 用于控制流与管线,Sequence 用于请求流与多步交互,ER 与 Class 图用于数据模型与对象层级。建议从 3-5 个节点起步。

使用方式:当项目根目录存在 ARCHITECTURE.md 时主动使用——重大改动前先阅读;结构调整后更新图表与入口点;新增组件时创建 docs/<component>.md 并从 ARCHITECTURE.md 链接;重构时更新受影响的图表与文件引用。初始建立流程包括分析代码库结构、识别入口点、梳理主要组件与职责、追踪关键数据流、编写 ARCHITECTURE.md,再为组件创建细节文档。细节文档在组件拥有 3 个以上关键文件或抽象、内部逻辑复杂、与其他组件交互多、需要时序图说明流程时创建;命名灵活,与组件身份一致即可。

适用场景:需要长期维护架构说明的项目,尤其是多组件、复杂数据流或频繁结构性变更的代码库;也用于新人快速定位入口点与核心抽象。

限制:资料未提供具体的安装命令、运行环境、依赖条件、收费方式或效果承诺;文档模板与 Mermaid 图表示例位于 references/document-templates.md 与 references/mermaid-patterns.md,但本次资料未给出其内容细节。维护时应确保入口点表准确、图表节点与实际组件一致、表内文件路径有效,并同步更新受影响的细节文档。