1. 基本信息
| 项目 | 内容 |
|---|---|
| 名称 | ai-doc-gen |
| 作者/维护者 | Divar（伊朗大型分类信息平台官方 GitHub 账号） |
| 来源链接 | https://github.com/divar-ir/ai-doc-gen |
| 许可证 | MIT（数据来自 GitHub API） |
| GitHub Stars | 737（数据来自 GitHub API，2026-07-23） |
| Forks | 79（数据来自 GitHub API，2026-07-23） |
| 最新版本 | v1.0.0（插件清单 plugin.json 声明版本号，仓库尚未创建正式 Release） |
| 安装方式 | Claude Code 插件市场一条命令安装 |
2. 功能介绍与亮点
ai-doc-gen 以 Claude Code 插件形式打包了三个协同技能：
- analyze-codebase：并行调度五个子 agent，分别分析代码库的结构、依赖关系、数据流、请求流与 API 接口，产出结构化的 Markdown 分析文档，写入仓库的
.ai/docs/目录。 - generate-readme：读取上述分析结果（或直接探索代码库），生成包含架构说明、依赖与 API 文档的专业 README。
- generate-ai-rules：基于同一份分析，同时生成 CLAUDE.md、跨工具标准的 AGENTS.md，以及 Cursor 的
.cursor/rules/*.mdc，让多种 AI 编程助手共享一致的项目约定。
主要亮点：由企业官方账号 Divar 维护并开源，MIT 协议完全开源；技能路径完全依赖 Claude Code 自身的文件与子 agent 工具完成分析和写作，不需要额外安装 Python 环境或配置模型 API Key；三个技能的 SKILL.md 都写明了失败重试与结果校验步骤，工程细节完整。
3. 适用场景
所属分类：工程效率与代码质量
- 新加入项目的工程师，用它在几分钟内拿到一份结构化的代码库架构分析
- 需要为陌生或年久失修的代码库补齐、刷新 README 的维护者
- 想给项目统一引入 CLAUDE.md / AGENTS.md / Cursor rules 等 AI 助手配置文件的团队，避免多份配置各写各的、逐渐失配
4. 跨 Agent 兼容性
- Claude Code：原生支持。仓库提供
.claude-plugin清单与skills/目录，通过/plugin marketplace add与/plugin install一条命令安装；三个技能的工作流依赖 Claude Code 的子 agent（Task）并行调度能力。 - Codex / OpenClaw / Hermes Agent：未验证。README 与 SKILL.md 均未提及针对这三者的安装或测试方式。其产出物之一 AGENTS.md 是跨工具通用配置文件标准，Codex 等遵循该标准的工具可以读取生成结果，但这不等同于该技能本身可直接安装到这些 agent 中运行。
5. 推荐理由
它能让 Claude Code 在几分钟内看懂一个陌生代码库，并落地成可直接提交进仓库的标准 README 与 AI 助手配置文件；由企业官方团队持续维护、无需额外账号或 API Key 即可运行，对初中级开发者接手或维护代码库是低摩擦的起点。
6. 评分
| 维度 | 分数 | 说明 |
|---|---|---|
| 受欢迎程度 | 7 | 737 stars（GitHub API，2026-07-23）；仓库有 5 个以上外部账号提交功能 PR，一条 issue 收到具体的模型上下文长度反馈并促成后续修复，构成有活跃度的社区参与，但尚未达到千星量级，也未见独立媒体报道 |
| 可用性 | 9 | 技能安装路径无需配置模型 API Key、无需安装 Python 环境，Claude Code 内一条命令即可安装；三份 SKILL.md 均写明清晰步骤与失败处理逻辑；仓库最近一次提交在两天前 |
| 安全性 | 8 | 见下方安全检查清单 |
安全检查清单：
- shell 命令及权限范围：技能指令本身不直接执行 shell 命令，而是调度 Claude Code 自身的文件读写与子 agent（Task）工具在目标仓库内读码、写文档，操作范围限定在被分析仓库内
- 运行时联网外发：未发现。三份 SKILL.md 均为本地文件分析与生成，不涉及外部网络请求（仓库中另有一套面向 GitLab 定时任务的独立 Python CLI，联网调用 LLM API，但该模式与 Claude Code 技能安装路径互相独立，非使用技能所必需）
- API Key / 凭据：技能安装与运行路径不要求任何凭据
- 可疑指令：逐份阅读三份 SKILL.md 原文，未发现提示注入或隐蔽指令
- 作者信誉：Divar 官方 GitHub 组织账号，仓库由 3 名以上贡献者共同维护，无刷星或自我造假迹象
- License：MIT，明确
- 最近维护：最后一次提交在 2026-07-21，活跃
7. 跟同类 Skills 相比的优势
| 技能 | 定位 | 与 ai-doc-gen 的差异 |
|---|---|---|
| oh-my-mermaid | 把代码库转换成可递归下钻的可视化架构图，面向“用图看懂代码库” | ai-doc-gen 产出的是文字型 README 与 AI 助手配置文件而非架构图，二者更偏互补而非替代 |
| graphify | 把代码 / 文档 / 论文构建为可持久查询的知识图谱，面向跨会话复用检索上下文的场景 | ai-doc-gen 聚焦一次性生成标准文档产物，不建立长期可查询的图数据库 |
| Understand-Anything | 将代码库转成可探索知识图谱，帮新人快速看懂架构，偏交互式探索 | ai-doc-gen 的产出物是静态 Markdown 文件，可直接提交进代码库、被 git 版本管理，不需要额外的图谱查看器 |
ai-doc-gen 不做可视化图谱，换来的是产出物可以直接落盘、进入版本控制、被其他遵循 AGENTS.md 标准的 AI 工具直接读取的实用性。
8. 用户评价
该技能目前在第三方平台（如 Reddit、Hacker News、Medium）尚无独立的具名用户评价。仓库自身的 GitHub Issues 中有开发者反馈过大型代码库下的模型上下文长度限制问题，团队随后提交 PR 做出修复。
9. 安装使用方式
在 Claude Code 内执行：
/plugin marketplace add divar-ir/ai-doc-gen
/plugin install ai-doc-gen@divar安装完成后无需重启，直接用自然语言触发三个技能，例如：“分析这个代码库”、“帮我写 README”、“生成 CLAUDE.md 和 AGENTS.md”。
10. 注意事项
- 分析文档可能与代码实际状态存在滞后，SKILL.md 本身也提示需要与代码核对后再采信关键结论
- 仓库另附一套独立的 Python CLI，用于 GitLab 定时任务等更复杂的自动化场景，该路径需要自备兼容 OpenAI API 的模型密钥，与 Claude Code 技能安装路径相互独立，仅使用技能本身不需要配置它
- 仓库尚无正式版本 Release，当前版本号依插件清单声明为 v1.0.0