Files
clean-architecture-backend-…/docs/README.md
T
DongHyeonka 3b66358e52 docs(improvement): 리뷰·개선 작업 매뉴얼을 만든다
문제: 이 repo를 리뷰하거나 결함 수정·리팩터링·성능 최적화·구조 변경을 할 때
기준으로 삼을 문서가 없다. docs/manual/은 새 기능을 만드는 순서이고, 리뷰
기준으로 써 온 공용 가이드는 프론트 repo에만 있으며 AGENTS.md·CLAUDE.md가
가리키지 않는다. 2026-11-01부터 쌓인 소유자 결정과 반복 결함 패턴은 리뷰
문서 여러 곳에 흩어져 있다.

방법: docs/improvement/에 README, 01~09장, 결함 패턴 부록을 둔다. 규칙은
다시 쓰지 않고 정본(AGENTS.md, modules.json, application-core/CLAUDE.md,
TESTING_STRATEGY.md, src/build.gradle, 리뷰 문서의 결정 절)을 가리킨다.
정본이 없는 것 — 작업 종류별 절차, 이 repo의 28개 관점 점검 항목과 결함
정의, 반복 결함 패턴, 성능 측정 조건, 무거운 실행 위치, 결정 색인, 세션
분업과 리뷰 반복 종료 조건 — 만 매뉴얼이 정본이 된다. AGENTS.md에
「리뷰·개선 작업 기준」 절, CLAUDE.md에 그 요약을 두고 docs/README.md와
docs/manual/README.md에서 가리킨다. 프론트 매뉴얼과 같은 장 번호를 쓴다.
버린 대안: docs/reviews/ 안에 두기(결과 보관소와 기준서가 섞인다), 공용
가이드 복사(갈라진 복사본이 된다), 소유자 환경 규칙을 AGENTS.md에 직접
쓰기(파생 프로젝트가 정책 문서를 고쳐야 한다).

위험·한계: 매뉴얼을 정본과 대조하는 자동 검사는 없다(문서 파서를 두지
않는 repo 방침). 08장 결정 표는 색인이고 원문과 다르면 원문이 맞다. 저장소
밖 문서(공용 가이드, 커밋 규칙)는 lychee가 따라갈 수 없어 링크 대신 코드
표기로 썼다. 근거를 찾지 못한 것 하나(측정 스크립트를 scripts/perf/로
넣기)는 [제안]으로 표시했다.

검증: 인용한 저장소 경로·리뷰 ID·클래스 이름·태스크 이름·상대 링크·절
번호를 스크립트로 전수 대조했다(로컬, 읽기만). 남은 불일치는 저장소 밖
가이드 경로, 자리표시자, 제안 경로, 원래 있던 문장뿐이다. CLAUDE.md는
DeveloperExperienceContractTest가 요구하는 architectureTest 명령을 그대로
둔다. 문서 대조 lane은 이 커밋을 push한 뒤 desktop에서 돌린다.
2026-11-05 21:59:44 +09:00

3.1 KiB

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 표면 스냅숏
manual/ 개발 매뉴얼: 새 기능을 만드는 순서와 판단 지점, 생성 명령(scripts/new-feature.sh)
improvement/ 개선 작업 매뉴얼: 리뷰·결함 수정·리팩터링·성능 최적화·구조 변경의 절차와 기준, 소유자 결정 색인
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 가 소유한다.