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 功能。