SuperAPI AI 工具集

doc-architecture

写作与研究

查看项目

更新于 10-16 00:23

技能介绍

用途:为系统或组件生成架构文档,支持 arc42、C4 或两者兼用,默认使用 C4,C4 层级默认 container。

主要能力:分析代码库以识别系统边界、外部依赖、内部结构、技术栈与关键流程;按格式生成对应内容。C4 可生成 context(系统与用户及外部系统)、container(内部应用与数据存储)、component(容器内部结构)图,并附文字说明。arc42 可生成引言与目标、架构约束、系统范围与上下文、解决方案策略、构建块视图、运行时视图、部署视图、横切概念等章节。both 模式生成 arc42 文档并嵌入 C4 图。

使用方式:调用 /doc-architecture,可传入主题、format(arc42、c4、both)和 level(context、container、component)。示例:/doc-architecture "order service" 生成订单服务的 C4 容器图;format=arc42 生成完整 arc42 文档;format=c4 level=component 生成组件图;format=both level=context 生成含 C4 上下文图的 arc42 文档。输出文件位于 docs/architecture/,C4 为 {subject}-c4-{level}.md,arc42 为 {subject}-arc42.md,both 为 {subject}-architecture.md 与 diagrams/ 下的 context.mmd、container.mmd、component.mmd。

输出要求:含标题、更新时间、作者(若已知)、版本等元数据;使用 Mermaid 格式的图与图例;叙述涵盖上下文与目的、关键决策与理由、技术选择、取舍、相关文档链接,必要时含 ADR。

限制:资料未提供具体收费、价格、平台支持范围与效果保证;生成内容需以实际代码库分析为基础,可能受代码和现有文档完整度影响。