divar-ir/ai-doc-gen

解决的问题

随着代码库的演进，维护准确的代码文档是一项持续的挑战。本工具可自动创建和更新全面的 README 文件和 AI 助手配置文件，无需人工干预即可确保文档保持最新状态。

工作原理

该系统采用由 pydantic-ai 驱动的多智能体架构。它利用五个专门的分析智能体并行运行，以映射代码库的结构、依赖关系、数据流、请求流和 API。这些智能体将其发现保存到 .ai/docs/。随后，生成智能体利用这些分析结果来生成精美的 README.md 以及 AI 专用配置文件，如 CLAUDE.md、AGENTS.md 和 Cursor 规则。

适用对象

想要实现文档工作流自动化的开发人员和工程团队，特别是那些使用 AI 编程助手（如 Claude Code 或 Cursor）以及通过 cronjob 与 GitLab 集成以实现自动定期更新的用户。

亮点

• 多智能体分析：使用五个专门的智能体从不同维度进行深度的代码库分析。
• AI 助手优化：生成特定的规则和配置文件，以提高 AI 编程助手的性能。
• GitLab 集成：包含 cronjob 模式，可自动发现活动项目并提交带有更新文档的合并请求。
• 灵活的 LLM 支持：兼容任何与 OpenAI 兼容的 API，允许使用各种模型和提供商。
• Claude Code 插件：可以作为插件安装，直接在 Claude Code 环境中提供 analyze-codebase、generate-readme 和 generate-ai-rules 功能。