MrLesk/groma.md

해결하는 문제

아키텍처 다이어그램은 그려지는 순간 구식이 되는 경우가 많습니다. 이 도구는 실제 코드 변경에 따라 동기화되는 소프트웨어 아키텍처의 실시간 대화형 맵을 생성하여 "오래된 문서" 문제를 해결합니다.

작동 방식

groma.md는 저장소를 스캔하여 C4 기반 아키텍처 맵을 생성합니다. 이 맵을 일반 Markdown 파일로 Git 저장소에 직접 저장합니다. 아키텍처가 코드로 저장되므로 사용자나 코딩 에이전트가 맵에 가한 모든 변경 사항이 버전 기록에 추적됩니다. 소스 코드를 수정하면 맵이 자동으로 업데이트되어 새 구조를 반영하며, 수동 큐레이션, 설명, 구성 요소 그룹화는 유지됩니다.

대상 사용자

다이어그램 업데이트의 수동 오버헤드 없이 정확하고 최신의 아키텍처 문서를 유지하려는 개발자와 팀을 위한 것입니다. AI 코딩 에이전트를 사용하는 사람들에게 특히 유용합니다. 에이전트가 코드와 함께 아키텍처 문서를 읽고 업데이트할 수 있기 때문입니다.

주요 기능

• 실시간 업데이트: 코드를 저장할 때 맵이 자동으로 새로 고쳐져 문서가 현재 작업을 반영합니다.
• 로컬 및 프라이빗: 도구는 완전히 로컬에서 실행되며 계정이 필요 없고 코드를 외부 AI 서비스로 보내지 않습니다.
• 버전 관리: 아키텍처가 저장소의 Markdown으로 저장되므로 코드와 동일한 풀 리퀘스트에서 아키텍처 변경 사항을 검토할 수 있습니다.
• 대화형 브라우저 맵: 내장 웹 인터페이스를 통해 시스템, 컨테이너, 구성 요소를 확대/축소하고 그 뒤에 있는 소스 코드로 직접 연결할 수 있습니다.
• 확장 가능: 플러그인 기반 스캐너 시스템을 통해 다양한 프로그래밍 언어를 지원합니다.