일기 slecs

팀 지침 문서 계층 구조 명확화

목차

한 사이드 프로젝트의 CLAUDE.md 파일에서 마크다운 헤더 구조를 개선하고 서버에서 검증한 작업을 했다. 간단한 문서 수정처럼 보이지만, 팀 규모가 커질수록 이런 세부사항이 모여 지침 일관성을 결정한다는 생각이 들었다.

CLAUDE.md가 왜 중요한가

내 팀에서 AI 에이전트(Claude Code)를 쓸 때마다, 각 프로젝트의 루트에 있는 CLAUDE.md 파일을 읽는다. 이 파일은 "이 프로젝트에서 작업할 때 어떤 원칙을 따를 것인가"를 명시하는 일종의 로컬 가이드라인이다. 여기에 보안 룰, 코딩 스타일, 금지 사항, 도메인 용어 정의 같은 걸 담는다.

지금까진 각 프로젝트마다 이 파일을 독립적으로 만들고 유지했는데, 마주치는 문제가 있다:
- 파일이 여러 개일 때 헤더 규칙을 어느 수준까지 중첩해야 하나?
- 상위 프로젝트의 지침과 하위 프로젝트의 지침이 어떻게 상속되나?
- 사람이 읽을 때도, AI가 파싱할 때도 구조가 명확해야 한다.

"캐스케이드 헤더"가 의미하는 것

마크다운에서 캐스케이드(cascade)는 보통 스타일시트처럼 "상위 레벨에서 정의된 것이 하위 레벨로 자동 상속된다"는 뜻인데, 여기선 단순히 헤더 깊이를 일관되게 구조화한다는 뜻으로 봐야 한다.

개선 전 개선 후
헤더 레벨이 일관되지 않음 (# ↔ ### 스킵) # → ## → ### 순서대로 체계화
AI가 문서 구조를 파악하기 어려움 마크다운 파서가 트리 구조를 명확히 인식
관련 섹션들이 시각적으로 분산됨 같은 주제끼리 명확히 그룹화됨

예를 들어, "금지사항"과 "필수 프로세스"라는 두 섹션이 같은 수준이어야 하는데 헤더 레벨이 다르면, 읽는 사람도, AI도 둘을 동등한 개념으로 취급하지 않는다.

서버 검증의 의미

커밋 메시지에 "(서버검증)"이라고 붙인 건, 단순히 로컬에서 파일을 수정한 게 아니라 실제 서버 환경에서 이 파일이 제대로 작동하는지 확인했다는 뜻이다. 아마도:
- 여러 프로젝트의 CLAUDE.md가 심링크로 연결되어 있거나
- 중앙 저장소에서 배포되는 구조라면
- "내가 수정한 헤더 구조가 다른 곳에서도 일관되게 파싱되는가?"를 확인해야 한다.

이렇게 명시적으로 검증 단계를 거치는 게, 작은 문서 수정이 예상 밖의 영향을 미치지 않도록 한다.

팀 리더십 관점에서

이런 문서 정리 작업이 사소해 보이지만, 팀 규모가 커질수록 중요해진다. 왜냐하면:

  1. 온보딩 가속 — 새로운 팀원이 CLAUDE.md를 읽을 때, 헤더가 명확하면 핵심을 빨리 캐치한다.
  2. 도구의 일관성 — AI 에이전트가 여러 프로젝트를 오갈 때, 문서 구조가 일관되면 같은 방식으로 지침을 이해한다.
  3. 유지보수성 — 6개월 뒤에 내가 이 파일을 다시 수정할 때, 헤더 구조가 체계적이면 어디를 손질해야 하는지 쉽게 찾을 수 있다.

팀 내에서 이런 "문서 정리" 커밋들을 소홀히 하면, 결국 팀원들이 읽고 따를 지침 문서가 산만해진다. 그럼 각자 다른 방식으로 일하게 되고, 코드리뷰할 때 "이건 언제부터 규칙이었지?" 하는 논쟁이 생긴다. 그래서 나는 정기적으로 이런 메타 문서들을 손질하고, 서버에서 검증하는 것을 중요하게 본다.


🛒 이 글과 어울리는 추천 상품

*위 링크는 쿠팡파트너스 활동의 일환이며, 일정액의 수수료를 제공받을 수 있습니다.

댓글 0

첫 댓글 달아줘.