divar-ir/ai-doc-gen

해결하는 문제

코드베이스가 진화함에 따라 정확한 코드 문서를 유지하는 것은 지속적인 과제입니다. 이 도구는 포괄적인 README 파일과 AI 어시스턴트 설정 파일의 생성 및 업데이트를 자동화하여, 수동 작업 없이도 문서가 최신 상태를 유지하도록 보장합니다.

작동 방식

이 시스템은 pydantic-ai를 기반으로 하는 멀티 에이전트 아키텍처를 사용합니다. 5개의 전문 분석 에이전트가 동시에 실행되어 코드베이스의 구조, 종속성, 데이터 흐름, 요청 흐름 및 API를 매핑합니다. 이러한 에이전트는 분석 결과를 .ai/docs/에 저장합니다. 그 후, 생성 에이전트가 이러한 분석 내용을 사용하여 정교한 README.md와 CLAUDE.md, AGENTS.md, Cursor 규칙과 같은 AI 전용 설정 파일을 생성합니다.

대상

문서 워크플로우를 자동화하고자 하는 개발자 및 엔지니어링 팀, 특히 AI 코딩 어시스턴트(Claude Code 또는 Cursor 등)를 사용하는 분들과 cronjob을 통해 GitLab과 연동하여 자동화된 정기 업데이트를 수행하려는 분들에게 적합합니다.

주요 특징

• 멀티 에이전트 분석: 5개의 전문 에이전트를 사용하여 다양한 측면에서 코드베이스에 대한 심층 분석을 수행합니다.
• AI 어시스턴트 최적화: AI 코딩 어시스턴트의 성능을 향상시키기 위한 특정 규칙 및 설정 파일을 생성합니다.
• GitLab 통합: 활성 프로젝트를 자동으로 검색하고 업데이트된 문서가 포함된 머지 리퀘스트를 생성하는 cronjob 모드를 포함합니다.
• 유연한 LLM 지원: 모든 OpenAI 호환 API와 호환되어 다양한 모델 및 제공업체를 사용할 수 있습니다.
• Claude Code 플러그인: 플러그인으로 설치하여 Claude Code 환경 내에서 analyze-codebase, generate-readme, generate-ai-rules 기능을 직접 제공할 수 있습니다.