문제: 살아 있는 문서의 언어, 기록의 상태 표시, 인라인 코드 경로, 복사한 버전·개수를 아무 검사도 보지 않는다. lychee는 마크다운 링크만 보는데 경로 대부분은 인라인 코드로 쓰여 있고, leaf CLAUDE.md는 Spring Boot 버전을 4.0.0으로 적어 둔 채 낡았다. 고른 방법: Gradle 밖 scripts/check-docs.py 하나에 검사 넷을 둔다. - language: 살아 있는 문서와 ADR 본문이 한국어인가. 판정은 보고 언어 훅 H11과 같다(코드·명령·경로·인용을 빼고 영어 낱말 3개 이상, 한글 비율 0.3 미만이면 영어). - head: 기록·ADR 맨 위 머리 블록의 칸, 종류별 상태 어휘, 날짜, 한국어 요약, 현재 정본·대체됨 경로. - reference: 인라인 코드 안 src/·docs/·scripts/·infra/·.github/ 경로와 Gradle 경로가 지금 트리·registry에 있는가. 코드 블록, 「> 이력」 인용, 제거 표, upgrade/는 건너뛴다. leaf 기준 경로는 어느 파일의 끝부분과 맞으면 있다고 본다. - number: Spring Boot x.y.z와 leaf 개수 문장. 예외 목록(scripts/check-docs-exceptions.txt)은 2026-11-07 기준선 217줄이고 줄기만 한다. 줄마다 sha256 지문이 스크립트의 FROZEN에 있어야 해서 목록에 새 줄을 더하면 실패하고, 더는 걸리지 않는 줄을 남겨 두면 실패한다. workflow docs-check.yml이 PR마다 경로 필터 없이 자기 시험과 검사를 돌린다. 코드에서 파일을 지우는 변경이 문서를 낡게 만들기 때문이다. 같은 커밋에서 지도 CLAUDE.md의 Spring Boot 버전 복사를 정본 가리키기로 고쳤다. 버린 대안: 예외 목록 하나에 「늘리지 않는다」는 약속만 두는 방식(테스트의 KNOWN_DEVIATIONS와 같은 꼴)은 brief가 요구한 「더하면 실패」를 기계로 막지 못한다. 기준선을 git 이력(merge-base)과 비교하는 방식은 얕은 checkout에서 깨진다. 검사를 link-check.yml에 더하는 방식은 그 workflow가 docs 경로에만 걸리고 repository-contract 테스트가 trigger를 고정한다. CI 재편 때 단계 workflow로 접는다. 위험·한계: 타입 이름 검사(지운 클래스 이름)는 넣지 않았다. 외부 타입과 구분하려면 git 전체 이력이 필요하다. 경로 검사는 루트 폴더로 시작하는 경로만 보므로 src/ 기준 상대 경로(adapter/outbound/...)는 보지 않는다. leaf 개수 규칙은 설계 문서의 개수 같은 정당한 숫자도 잡을 수 있다(지금 generator 출력 예 하나가 예외 목록에 있다). 구조 정리가 src/messaging 등을 옮기면 예외 줄의 경로가 바뀌므로 그 병합에서 FROZEN을 함께 고쳐야 한다. 레지스트리 yaml 설명 칸의 언어는 보지 않는다. 검증: python3 -m unittest discover -s scripts/tests 42개 통과. 변이 시험: 기준선 확인·낡은 예외 확인·언어 판정·이력 인용 건너뛰기·소스 세트 이름· 끝부분 대조·상태 어휘를 하나씩 끄면 해당 시험이 실패했다. python3 scripts/check-docs.py rc=0(language 181·reference 7·number 29가 모두 예외, head 0), check-work-docs.py rc=0.
7.4 KiB
7.4 KiB
CLAUDE.md — 이 repo의 지도
이 파일은 세션이 처음 읽는 지도다. 규칙을 담지 않고, 어떤 일이면 무엇을 읽을지 가리킨다.
1. 이 repo
- Java 21 + Spring Boot Gradle 멀티모듈(버전은
src/gradle/libs.versions.toml) Clean Architecture 백엔드 템플릿이다. 서비스는 이 repo를 받아 도메인을 채운다. - Gradle 루트는
src/다. Gradle 명령은src/에서 실행한다. - 규칙의 정본은
AGENTS.md다. leaf 목록·경로·허용 의존의 정본은src/config/architecture/modules.json(registry)이다. 각 leaf의 지역 규칙은 가장 가까운src/**/CLAUDE.md가 정한다.
2. HARD-STOP — 하나라도 어기면 완료가 아니다
정본은 AGENTS.md 「Prime Directive」다. 두 문서가 다르면 AGENTS.md가 맞다.
domain-core가 framework·transport·database·cloud 의존성을 가진다.- controller가 repository·Spring Data interface·persistence entity를 직접 쓴다.
- inbound DTO가
application-core나domain-core로 들어간다. - 업무 규칙이 mapper·filter·configuration·settings·controller로 옮겨 간다.
- 프로젝트 의존성이 registry나 Gradle 의존성 검증을 어긴다.
- 관련 검증 없이, 또는 돌리지 못한 이유를 밝히지 않고 완료를 말한다.
- 결론의 범위와 위험에 맞는 증거 없이 저장소 전체에 대한 결론을 낸다.
3. 맡은 일 → 읽을 문서
먼저 docs/work/README.md를 읽는다. 크기 정하기, 모든 작업의 공통 단계, 커밋 규칙이 거기 있다. 그다음 맡은 일의 playbook 하나를 끝까지 읽는다.
| 맡은 일 | playbook |
|---|---|
| 새 업무 기능, 새 capability 모듈 | docs/work/new-feature.md → docs/manual/ |
| 리뷰, 결함 수정, 리팩터링, 성능, 구조·테스트 구조 개선 | docs/work/improve.md |
| 바꾸기 전에 대안 비교와 소유자 결정 | docs/work/research-design.md |
| 매뉴얼·안내 문서 쓰기 | docs/work/docs-writing.md |
| 게이트 실행, desktop 검증, 릴리스, 파생 서비스 | docs/work/operate.md |
| 큰 일을 나눠 다른 세션에 맡기기 | docs/work/delegate.md |
brief(작업 지시문)가 있으면 brief의 범위·크기·완료 기준이 먼저다. playbook은 brief에 없는 공통 절차를 채운다.
4. 검증 명령과 실행 위치
- 실행 위치: 소유자 환경에서는 Gradle·Docker·테스트·게이트를 desktop에서만 돌린다. 절차는 docs/work/operate.md 4.1절이다.
- leaf 하나: registry에서 그 leaf의
gradle_path를 읽고./gradlew <gradle-path>:test --console=plain또는:check를 돌린다. 기억이나 디렉터리 이름으로 Gradle path를 짐작하지 않는다. - 저장소 전체 질문:
./gradlew architectureCheck --console=plain
./gradlew :app-bootstrap:architectureTest --console=plain
./gradlew verifyPublicPathSnapshot --console=plain
./gradlew :app-bootstrap:verifyEnvKeys --console=plain
- 공개 경로 검사와 env 키 검사는 그 표면이 바뀌었을 때 돌린다. 전체
test·check·ci는 brief가 시킬 때 돌린다. - 게이트 목록(
ci,mainCheck,integrationCheck,performanceCheck,releaseCheck등)과 바꾼 것에 맞는 게이트는 docs/work/reference/gates.md다. docs/work/, 이 파일,AGENTS.md,src/**/CLAUDE.md를 고쳤으면python3 scripts/check-work-docs.py를 돌린다(분량, 본문 이력 ID 0, 상대 링크).- 문서(
.md)나 문서가 가리키는 경로·Gradle 프로젝트를 바꿨으면python3 scripts/check-docs.py를 돌린다(언어, 기록의 머리 블록, 참조, 복사한 숫자). PR마다docs-checkworkflow가 같은 검사를 돈다. 규칙은 docs/README.md다.
5. 코드만 보고는 헷갈리는 곳
- leaf 목록은 registry 하나다. 문서는 leaf 개수를 적지 않는다(적힌 수는 leaf가 늘면 틀린다). runtime membership 목록은 없다. 조립 루트가 받을 수 있는 모듈은 registry의
allowed_dependencies가 정하고, 방향 게이트가 그 밖의 edge를 막는다. src/messaging/*는 Clean Architecture 계층이 아니다. 자기 API·SPI·adapter·조립 경계를 가진, 들여온(vendored) 메시징 제품이다.domain-core·application-core·shared-contract에 의존하지 않는다. 이 애플리케이션은adapter:outbound:messaging의 bridge로만 닿는다. 이유와 지역 규칙은src/messaging/CLAUDE.md다.composition:*leaf는 조립만 한다. outbox relay, 멱등성 executor, durable operation처럼 bootstrap에서 떼어 낸 조립이다. 각각runtimeOnly한 줄로 고른다.- capability는 한 줄로 켜고 끈다. 기본 조립은 web inbound, 운영 관측, core들, support·identifier뿐이다. JPA도
src/app-bootstrap/build.gradle의runtimeOnly한 줄로 켠다. 규칙은AGENTS.md「부가 기능(capability) 모듈 규칙」이다. - gRPC 플랫폼 라이브러리는 다른 빌드다.
src/grpc/*·src/grpc-advanced/*(registry의"build": "optional-grpc")는-p optional-platforms로 돈다.adapter:inbound:grpc는 애플리케이션 adapter라 주 빌드에 있다. src/sample-portfolio는 지울 수 있는 샘플이다. 한 leaf에 모든 계층을 둔 모양이라 배치를 따라 하지 않는다. 새 기능의 예시는scripts/new-feature.sh의 출력이다.- 성능 lane에는 단언을 끄는 스위치가 없다. convention이 상한을 매번 단언하고,
performance.assertions.enabled에true아닌 값이 들어오거나 skip이 있으면 테스트 전에 실패한다. 손으로 돌리든 workflow든 같다(AGENTS.md「Gradle 정책 권위」). - 저장소 파일을 읽는 테스트는 태그가 있다. 문서와 대조하는 테스트는
document-contract(main 단계mainCheck), 빌드 스크립트·workflow를 읽는 테스트는repository-contract(PR)다. 문서를 고치면 그 문서를 읽는 테스트를 찾는다. - 커밋 정책은
human-only다. brief가 허용한 것만 자기 브랜치에 한다. 커밋과 push는 따로 허용된다. 자세한 것은 docs/work/README.md 4절이다. - 문서 위치 규칙은 docs/README.md다. 설계서는
docs/design/, 결정 기록은docs/adr/, 리뷰는docs/reviews/, 고치지 않는 기록(계획서·납품 패키지·증거·학습)은docs/history/, 파생 서비스용 변경 안내는docs/upgrade/다. 기록은 맨 위 머리 블록만 고친다.
6. 소유자 환경
- 이 repo 소유자의 기계·세션 도구에 묶인 규칙은 두 곳에만 있다: docs/work/operate.md 4.1절(실행 위치)과 docs/work/delegate.md 4.3절(세션). 공용 정본은 design-docs
conventions/delegation-loop.md11절이다. - Agent 도구(세션 안의 하위 에이전트)는 이 repo의
.claude/settings.json이 막는다. 일을 나눌 때는 delegate.md대로 별도 세션에 맡긴다. - 작업 사고 순서의 정본은 design-docs
conventions/work-thinking-order.md, 커밋·PR 형식은conventions/commit-and-pr.md다. - 보고 말투와 형식은 소유자의 전역
~/.claude/CLAUDE.md를 따른다.