ai-doc-gen Skill：让代码文档自己长出来的多 Agent 神器

ai-doc-gen Skill：让代码文档自己长出来的多 Agent 神器

ai-doc-gen 是一个基于多 Agent 架构的 AI 代码文档生成系统，通过 5 个专业分析 Agent 并发运行，自动拆解代码仓库的结构、依赖、数据流、接口，输出结构化 README 与 AI 助手配置文件。截至 2026-08-19 在 GitHub 获 748 star、79 fork，支持任意 OpenAI 兼容 API，提供 Claude Code 插件形态安装，开源协议为 MIT。

功能与原则

ai-doc-gen 的核心能力建立在”分析-生成”双阶段流程上。分析阶段由 5 个专业 Agent 并发执行，分别负责代码结构（文件树与模块关系）、数据流（状态穿越路径）、依赖关系（包/模块导入拓扑）、请求流（API 调用链路）、API 接口（Endpoints 与输入输出契约）五个维度的深度解析，每个 Agent 的输出写入 .ai/docs/ 目录作为下一阶段的原材料。生成阶段则由 DocumenterAgent 消费分析文档产出完整 README，AIRulesGeneratorAgent 并发生成 CLAUDE.md、AGENTS.md 和 Cursor rules 三类 AI 助手配置文件。整个流程遵循”协作而非替代”原则——Agent 只做结构化分析，最终文档风格由用户配置控制。

认可度

• GitHub star：748（截至 2026-08-19）
• Forks：79
• 最后更新：2026-08-19（当日活跃）
• 语言：Python 3.13
• 许可证：MIT
• 归属 Topic：claude-code-skill（第 2325 个收录仓库）
• GitHub 页面长期活跃更新，最近一次 commit 为 2026-08-19

链接

GitHub：https://github.com/divar-ir/ai-doc-gen

原作者

• 团队/个人：divar-ir（GitHub Username）
• 背景：伊朗开发者团队，专注 AI + 开发工具链，旗下还有 claude-blog、claude-ads、claude-seo 等一系列 Claude Code Skills，形成了围绕 Claude 生态的产品矩阵
• 代表项目：ai-doc-gen 主仓库 + Medium 技术博客”Docs That Don’t Rot: How Multi-Agent AI Rewrote Our Workflow”详细阐述设计思路

介绍

ai-doc-gen 的设计初衷直击工程现实痛点：代码仓库的文档往往在第一版上线后迅速过期，人工维护成本极高，而传统的 AI 生成文档只是简单复述代码，缺乏对系统架构的深度理解。该项目采用多 Agent 协同架构，将代码理解任务分解给 5 个专项分析 Agent 并发执行，每个 Agent 专注一个维度（结构/依赖/数据流/请求流/API），最终由文档生成 Agent 整合所有分析结果，产出真正有信息量的 README 和 AI 助手配置文件。这种”分工分析 + 整合输出”的模式，比单 Agent 直接生成文档的准确率和深度都显著更高。

项目同时支持 GitLab Cronjob 模式，可配置为定时扫描团队内活跃项目，自动运行分析并提交带文档的 Merge Request，将代码文档维护从”手动想起来做”变成”自动持续更新”。在模型支持方面，由于底层采用 OpenAI 兼容 API，用户可接入 OpenAI、Anthropic 兼容网关、OpenRouter 或本地模型，per-agent 独立配置模型和端点，灵活性极强。配置体系采用分层设计：Pydantic 默认值 < .ai/config.yaml 文件 < CLI 参数，优先级清晰，调试友好。

特点

• 多 Agent 并发分析：5 个专项 Agent（代码结构/数据流/依赖/请求流/API）同时运行，分析效率高且各维度深度独立
• Claude Code 插件一键安装：/plugin marketplace add divar-ir/ai-doc-gen 即可装入 Claude Code，无需 API Key 和 Python 环境
• GitLab 自动推送：Cronjob 模式自动发现活跃项目并提交带文档的 MR，团队文档维护零成本
• 多模型灵活接入：基于 OpenAI 兼容 API，可接入任意 provider，支持 per-agent 独立配置
• 可观测性完善：集成 OpenTelemetry（logfire）+ Langfuse，Agent 执行链路全程可追踪
• 拒绝覆盖保护：生成 AI rules 时可跳过已有文件，避免误操作覆盖团队自定义配置

使用方法

方式一：Claude Code 插件（最简）

/plugin marketplace add divar-ir/ai-doc-gen
/plugin install ai-doc-gen@divar

装完获得三个 Skill：
– analyze-codebase — 执行多 Agent 分析，产出 .ai/docs/ 分析文档
– generate-readme — 从分析文档或直接探索生成 README.md
– generate-ai-rules — 生成 CLAUDE.md、AGENTS.md、Cursor rules

方式二：Python 包安装（完整功能）

# 克隆仓库
git clone https://github.com/divar-ir/ai-doc-gen.git
cd ai-doc-gen

# 安装（推荐 uv）
curl -LsSf https://astral.sh/uv/install.sh | sh
uv sync

# 配置
cp .env.sample .env
mkdir -p .ai && cp config_example.yaml .ai/config.yaml

# 分析代码库
uv run src/main.py analyze --repo-path .

# 生成 README
uv run src/main.py generate readme --repo-path .

# 生成 AI 助手配置
uv run src/main.py generate ai-rules --repo-path .

方式三：Docker / Kubernetes（团队部署）

项目提供了 Dockerfile 和 Helm Chart（k8s/helm/），适合企业内网部署和定时批量处理。

使用场景与人群

适用场景：
– 新接手陌生代码仓库，需要快速生成架构文档
– 开源项目维护者，希望 README 和 AI 助手配置文件自动保持更新
– 开发团队需要批量为多个仓库生成标准文档
– AI 编程工具（Claude Code/Cursor/Codex）使用者，希望注入更精准的上下文

目标用户：
– 后端/全栈工程师
– 开源项目 maintainer
– 技术 lead 需要快速掌握团队代码库全景
– DevOps/平台工程师搭建内部文档自动化流水线

输入与输出案例

案例 1：analyze-codebase

输入：

uv run src/main.py analyze --repo-path /path/to/my-project

输出（.ai/docs/ 目录）：

.ai/docs/
  ├── code-structure.md      # 文件树 + 模块关系图
  ├── data-flow.md           # 状态/数据穿越路径
  ├── dependencies.md        # 包导入拓扑
  ├── request-flow.md        # API 调用链路
  └── api-endpoints.md       # 接口定义与契约

案例 2：generate-ai-rules

输入：

uv run src/main.py generate ai-rules --repo-path /path/to/my-project 
  --detail-level comprehensive 
  --max-claude-lines 600

输出：

my-project/
  ├── CLAUDE.md          # Claude Code 的行为规范文件
  ├── AGENTS.md          # 多 Agent 协作协议
  └── .cursor/rules/    # Cursor IDE 的上下文规则

生成的 CLAUDE.md 内容示例片段：

# Project: my-api-service

## Architecture
本项目为 RESTful API 服务，采用分层架构...
（来自 analyze-codebase 的结构分析结果）

## Code Style
- 优先使用 dataclass 而非 dict
- 所有 API 路由须带类型注解
...

GitHub: https://github.com/divar-ir/ai-doc-gen