FSoft-AI4Code/CodeWiki

해결하는 문제

CodeWiki는 대규모 코드베이스에 대한 포괄적인 저장소 수준 문서 생성을 자동화합니다. 수천 줄에서 수백만 줄에 이르는 다양한 프로그래밍 언어로 작성된 프로젝트에서 아키텍처 개요와 모듈 설명을 수동으로 작성하는 수고를 없앱니다.

작동 방식

이 도구는 저장소를 분석하여 의존성 그래프를 구축한 다음, 이를 모듈의 계층적 트리로 분할합니다. AI 에이전트가 재귀적으로 배포됩니다. 리프 모듈 에이전트는 코드를 기반으로 개별 페이지를 작성하고, 상위 모듈 에이전트는 이러한 하위 페이지를 종합하여 상위 수준 개요를 만듭니다. 또한 Dockerfile 및 CI 워크플로와 같은 비코드 산출물을 그래프에 통합하여 빌드 및 배포 프로세스를 문서화합니다. 시스템은 증분 업데이트를 지원하므로 코드 변경 후 전체 문서 세트를 다시 생성하는 대신 영향을 받는 모듈만 패치할 수 있습니다.

대상 독자

대규모 프로젝트의 소프트웨어 엔지니어, 아키텍트, 유지보수 담당자로서 수동 유지보수 부담 없이 최신의 고수준 문서가 필요한 분들을 대상으로 합니다.

주요 기능

• 다중 언어 지원: Python, Java, C++, Rust, TypeScript를 포함한 11개 언어 지원.
• 계층적 분해: 의존성 그래프를 관리 가능한 모듈 트리로 클러스터링하여 수백만 줄의 저장소로 확장.
• 산출물 인식: 코드와 함께 빌드 파일, 패키지 매니페스트, 구성 스키마를 문서화.
• 증분 업데이트: 특정 코드 커밋의 영향을 받는 페이지만 업데이트하여 비용과 시간을 절감.
• IDE 통합: Cursor 또는 Claude Desktop과 같은 AI IDE에서 사용할 수 있는 MCP 서버 제공.
• 다국어 출력: 다양한 언어(예: 일본어, 베트남어)로 문서를 생성할 수 있음.