큰 코드 저장소 문서화에 Claude Code만으로는 부족했다
대형 를 개발자, 품질 담당자, 가 함께 볼 수 있는 로 정리하려는 시도다. 목표는 하나의 긴 문서가 아니라, 필요한 만큼 단계적으로 펼쳐 보는 문서 묶음을 만드는 것이다.
필요한 문서에는 저장소 전체 개요, 모듈별 책임과 경계, 시스템 구조, 데이터 흐름, 업무 규칙, 핵심 로직 흐름, 주요 API와 진입점이 포함된다. Claude Code와 로 저장소를 훑어 문서를 만들었지만 결과는 얕았고, 결론이 어떤 코드 근거에서 나왔는지 불분명했다.
특히 실제 서비스 동작을 이해하는 데 중요한 핵심 로직 흐름이 거의 빠졌다. 실제 에서 더 나은 프롬프트, 문서 형식, 스킬을 찾고 있다.
핵심 포인트
- 목표는 개발자, 품질 담당자, 가 함께 쓰는 를 만드는 것이다.
- 원하는 문서는 전체 개요, 모듈 책임, 시스템 구조, 데이터 흐름, 업무 규칙, 핵심 로직, 주요 API를 나눠 담아야 한다.
- Claude Code와 로 만든 결과는 내용이 얕고 코드 근거가 잘 보이지 않았다.
- 핵심 로직 흐름이 거의 빠져 실제 동작을 이해하기 어려웠다.
- 문서화에는 프롬프트뿐 아니라 문서 구조와 검증 방식이 필요하다.