Files
clean-architecture-backend-…/docs
DongHyeonka c508b1ba4b docs: 회복 필요 응답의 클라이언트 안내를 한 가지로 맞추고 확인 리뷰를 기록한다
문제: 70fb80bf 뒤 IDEMPOTENCY_RECOVERY_REQUIRED에 대한 클라이언트 안내가
문서마다 달랐다. http-contract 표는 새 키 금지, 매뉴얼 05 표는 옛 문구(재전송도
위험), runbook은 효과가 없으면 새 키라고 했다. 결정 ① 뒤에는 같은 키 재전송이
작업을 다시 돌리지 않으므로 안전하다.

방법: 세 문서를 "자동 재시도 안 함, 같은 키 재전송은 안전(서버가 판정하고
다시 돌리지 않음), 효과가 없다고 확인된 뒤에만 운영 절차에 따라 새 키"로
맞췄다. 70fb80bf 확인 리뷰(Important 0, Minor 9) 결과를 재리뷰 README 15.2절과
round5/review.md에 남기고, 업그레이드 안내의 결정 행에 커밋 해시를 적었다.

위험·한계: 문서만 바뀐다. 나머지 Minor 8건은 기록만 했다.

검증: :app-bootstrap:documentContractTest, :app-bootstrap:repositoryContractTest
통과.

Refs: docs/reviews/2026-11-03-rereview/README.md 15.2절
2026-11-04 20:36:39 +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 표면 스냅숏
manual/ 개발 매뉴얼: 새 기능을 만드는 순서와 판단 지점, 생성 명령(scripts/new-feature.sh)
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 가 소유한다.