Claude를 활용한 20만 라인 규모 SaaS의 문서화 자동화 사례

실용적 조언

.docsignore 파일을 활용하여 AI가 분석하지 말아야 할 민감한 내부 시스템이나 설정 파일을 사전에 필터링하라.
문서 생성 단계와 보안 검토 단계를 분리하여 별도의 에이전트가 교차 검증하게 함으로써 안전성을 높여라.

섹션별 상세

작성자는 코드 디렉토리별로 Claude가 소스 코드를 분석하여 help.md 파일을 생성하도록 자동화했다. 입력된 코드를 바탕으로 UI 기능을 파악한 뒤 기술적 전문 용어와 일반 사용자용 정보 사이의 균형을 맞춘 고객 지원 문서를 출력한다. 20만 LOC 규모의 프로젝트에서 매번 수동으로 작성하던 도움말 페이지의 관리 부채를 완전히 제거했다.

text

Review the code in this directory to understand the UI functionality. Then write a public facing customer-support help doc...

코드 디렉토리를 분석하여 고객 지원용 도움말 문서를 생성하도록 지시하는 프롬프트 예시

매일 밤 실행되는 예약 작업(npm run canonize)을 통해 새로운 커밋 내역을 분석하고 문서, 웹사이트, 변경 이력(Changelog)을 자동으로 갱신한다. 이 시스템은 .docsignore 파일을 사용하여 내부 시스템 코드를 제외하고 별도의 보안 검토 에이전트를 거쳐 안전성을 확보한다. 이를 통해 문서가 실제 코드 상태와 항상 100% 일치하는 정합성을 유지한다.

자동 생성된 help.md 파일들은 단순 문서화에 그치지 않고 RAG(검색 증강 생성) 시스템의 지식 베이스로 직접 활용된다. 고객 지원 에이전트가 이 문서들을 참조하여 사용자 질문에 답변함으로써 기술 지원 업무의 효율성을 극대화했다. 소규모 팀에서 개발과 문서화, 고객 지원을 동시에 수행해야 하는 리소스 한계를 AI 워크플로로 극복한 사례이다.

용어 해설

검색 증강 생성(RAG): — 외부 지식 베이스에서 관련 정보를 검색하여 LLM의 응답 생성에 활용하는 기술이다. 모델의 학습 데이터에 없는 최신 정보나 특정 도메인의 문서를 실시간으로 참조하여 답변의 정확도를 높이고 환각 현상을 줄이는 데 필수적이다.
표준화/정전화(Canonize): — 이 아티클에서는 코드 변경 사항을 분석하여 공식적인 문서나 변경 이력(Changelog)으로 자동 변환하고 확정하는 프로세스를 의미한다. 분산된 정보를 하나의 신뢰할 수 있는 표준 문서로 통합하는 자동화 워크플로의 핵심 단계이다.
코드 라인 수(LOC): — 소프트웨어 프로젝트의 규모를 측정하는 지표로, 소스 코드의 전체 줄 수를 의미한다. 본 사례에서는 20만 라인 규모의 복잡한 SaaS 시스템을 관리하는 맥락에서 프로젝트의 복잡성을 나타내는 수치로 사용됐다.

언급된 도구

Claude추천

코드 분석 및 고객 지원 문서 생성, 웹사이트 업데이트

npm중립

문서 표준화 및 자동 업데이트 스크립트 실행 환경