Files
clean-architecture-backend-…/docs
DongHyeonka 51230caf62 fix(scripts): 색인 절을 총괄이 쓰는 라운드의 색인 검사를 --extra-index로 한다
문제: 독립 리뷰어 둘이나 여러 리뷰 세션이 한 라운드를 나눠 보면, 정본 리뷰어는
영역 문서를 리뷰 폴더에 커밋하지만 README 색인 절은 총괄이 쓴다. 그래서 정본
리뷰어가 커밋한 트리의 색인 검사는 반드시 rc=1인데, improve.md는 리뷰어에게
rc=0을 요구했다(round8 발견 RR8-06-01). 두 규칙을 함께 지킬 수 없었다.

고른 방법: check-review-index.py에 --extra-index <파일>을 더했다. 리뷰어가
보고에 둔 색인 표 파일을 색인의 일부로 센다. improve.md 4.1절 7·8단계와 5절,
delegate.md 4.1절, 결정 색인 「리뷰 README 분담」에 쓰는 법을 적었다. 버린 안:
리뷰가 권한 "보고 표를 붙인 README 임시 사본" 절차 — 복사·붙이기 단계가 늘고
같은 대조를 손으로 한다. 정본 리뷰어가 README 색인 절을 먼저 쓰는 안 — 결정
「리뷰 README 분담」을 뒤집는다.

위험·한계: --extra-index는 넘긴 파일 전체를 색인으로 읽는다. 표만 담은 파일을
넘겨야 한다(노트 전체를 넘기면 본문에 나온 ID도 색인으로 센다). 매뉴얼에
"색인 표만 담은 파일"로 적었다.

검증(트리 3c305d7a, desktop 로그 ~/manual-gap-fix-2-logs/B-*):
- RED: 정본 리뷰어 커밋 27260ad0의 리뷰 폴더에 옵션 없이 rc=1(180 중 172)
- GREEN: 리뷰어 A의 색인 표를 --extra-index로 넘기면 rc=0(180/180)
- 지금 트리 docs/reviews/2026-11-03-rereview rc=0(182/182), 없는 파일을
  넘기면 rc=1
- check-work-docs.py 기본·--history docs/manual·--links rc=0

Refs: docs/reviews/2026-11-03-rereview/round8/06-manual-scripts.md RR8-06-01
2026-11-07 07:02:09 +09:00
..

docs

저장소의 모든 문서는 이 디렉터리 아래에 있다. 어떤 문서를 어디에 두는지가 유일한 규칙이고, 파일 목록은 디렉터리를 직접 읽는다. 개수를 여기에 적으면 다음 문서가 추가되는 순간 틀린 글이 된다.

어댑터별 운영 문서

각 어댑터의 지원 범위, 설정, 보안, 운영, 마이그레이션 문서다. 코드와 함께 갱신되어야 하는 문서이고, docs/httpclient/ 는 scripts/verify-httpclient-docs.py 가 코드에서 뽑은 이름과 대조한다.

디렉터리 대상
fileserver/ 파일 서버 어댑터
httpclient/ HTTP 클라이언트 플랫폼
jpa/ JPA·PostgreSQL 영속성
messaging/ 메시징 어댑터
mongodb/ MongoDB 문서 영속성 (advanced/, runbooks/ 포함)
notification/ 알림 전달 플랫폼 (adr/ 포함)
redis/ Redis 캐시·세션

횡단 문서

디렉터리 대상
adr/ 아키텍처 결정 기록
architecture/ 공개 API 표면 스냅숏
work/ 작업 매뉴얼: 이 repo에서 하는 일(새 기능, 개선, 조사·설계, 문서 작성, 운영, 총괄)의 절차서. 루트 CLAUDE.md 다음에 읽는다
manual/ 개발 매뉴얼: 새 기능을 만드는 순서와 판단 지점, 생성 명령(scripts/new-feature.sh). 입구는 work/new-feature.md
evidence/ 작업 단계별 증거·체크포인트
registries/ env 키·에러 코드·메트릭·헤더 등 레지스트리 SSOT
reviews/ 모듈 코드 리뷰 결과
runbooks/ 장애 코드별 대응 런북 (template.md 기준)
security/ 공개 경로 스냅숏

설계와 계획

디렉터리 대상
superpowers/specs/ 설계서. YYYY-MM-DD-<주제>-design.md
superpowers/plans/ 구현·확장 계획서. YYYY-MM-DD-<주제>-plan.md
superpowers/packages/ 외부에서 납품된 설계 패키지의 README와 정적 검증 결과

superpowers/packages/<어댑터>/ 는 설계서가 처음 전달됐을 때의 안내와 VALIDATION.md 검증 이력을 남긴 기록 보관소다. 설계서·계획서 본문은 전부 specs/ 와 plans/ 에 있으므로 이 디렉터리에서 문서를 찾을 필요는 없다. 각 README 상단의 보존 안내가 무엇이 옮겨졌고 무엇이 제거됐는지 밝힌다.

계획서 본문에는 당시 계획한 경로와 명령이 그대로 남아 있다. 그중 일부는 실제 구현에서 다른 위치로 조정됐고, 저장소에 어떻게 대응시켰는지는 각 어댑터의 repository-adaptation.md 또는 module-mapping.md 가 기록한다. 계획서를 사후에 고치지 않는 이유는 그렇게 하면 계획의 기록이 아니라 결과를 계획처럼 보이게 만든 글이 되기 때문이다.

여기에 없는 것

  • 실행되는 검증 스크립트는 문서가 아니다. scripts/ 와 .github/scripts/ 에 있다.
  • 모듈 레지스트리·Gradle 정책은 src/config/architecture/modules.json 과 src/build.gradle 이 소유한다.
  • 각 모듈의 지역 규칙은 해당 모듈의 src/**/CLAUDE.md 가 소유한다.