SuperAPI AI 工具集

smart-docs

通用与其它

查看项目

更新于 10-15 23:57

技能介绍

用途:smart-docs 是一个 AI 驱动的代码库文档生成技能,目标是为项目生成类似 Litho/deepwiki-rs 风格的综合专业文档,但完全依赖 Claude Code 原生能力,不调用外部 LLM API。

主要能力:按阶段渐进分析代码库,识别常见架构模式,按 C4 模型层级组织文档,使用 Mermaid 绘制可视化图表,输出结构良好的 Markdown 文件。文档结构包括项目概览、架构概览、工作流概览以及 Deep Dive 组件文档。

使用方式:技能按五个阶段执行。第一阶段项目发现,使用 tree、find、cloc 等命令了解目录结构、代码行数与入口点,并读取 README、构建配置和主入口文件。第二阶段架构分析,识别模块、映射依赖、检测架构模式与核心组件。第三阶段生成 ./docs/ 目录下的 Markdown 文档。第四阶段生成 Mermaid 图表,包括 C4Context、C4Container、序列图、类图、状态图、ER 图和流程图。第五阶段质量检查,验证 Mermaid 语法、交叉引用与格式一致性。

适用场景:需要综合代码库文档、希望获得 C4 模型架构图、理解陌生代码库、新成员入职、准备技术演示、维护文档,以及没有 Litho 或外部工具可用时。

限制:超大代码库(超过 1 万文件)受上下文窗口限制;可能无法捕捉复杂架构的全部细节;需要人工审查准确性;Mermaid 图表复杂度有限。该技能仅使用 Claude Code 订阅,不产生额外 API 调用或费用。官方未提供具体安装命令与定价信息。