Files
clean-architecture-backend-…/docs
DongHyeonka 81ef58ab17 docs(manual): 본문에 남은 이력 ID 19줄을 내용과 날짜로 바꾼다
문제: docs/manual 본문 19줄이 "리뷰 02-01 결정", "1라운드 06-01·06-03",
"리뷰 README 13.2, 09-02", "(05-01, 04-01, 06-01)", "sample P30 결정"처럼
지난 리뷰 번호만으로 이유를 댄다. 그 리뷰를 모르는 독자는 따라갈 수
없고, docs-writing.md 4절 6단계가 금지한다. 16줄은 --history 검사가
찾았고, 3줄은 걷어낸 뒤 grep으로 다시 읽어 찾았다.

고른 방법: 문장의 뜻은 두고 괄호만 바꾼다.
- 문장이 이미 내용을 말하는 곳(6줄)은 괄호를 지운다
- 지난 일이 근거인 곳은 날짜와 일어난 일로 바꾼다. 예: "2026-11-01
  소유자 결정", "2026-11-01부터. 전에는 비어 있으면 검증을 건너뛰었다"
- README 제목 "1라운드 수정으로 생긴 패턴 (리뷰 README 13절)"은
  "리뷰 뒤 첫 수정으로 생긴 패턴"으로 바꾼다. 이 제목을 가리키는 링크는
  repo에 없다
걷어낸 번호와 원래 괄호, 원래 리뷰 문서와 발견 내용은
docs/work/evidence.md 8절에 표로 더했다(2026-11-06 표와 같은 칸).
버린 대안: 리뷰 문서로 링크 걸기. 본문이 다시 이력을 가리킨다.

위험·한계: 날짜와 "전에는" 문장은 1101 README 13절·15절과 영역 문서의
색인 문장에서 옮겼다. 코드로 다시 확인하지는 않았다. evidence.md 9절
T4-1 행("16줄은 고치지 않음")은 그때의 기록이라 고치지 않았다.

검증(desktop worktree, 이 커밋과 같은 트리 8ff82a67):
- python3 scripts/check-work-docs.py --history docs/manual
  lines with history IDs: 0, rc=0
- python3 scripts/check-work-docs.py rc=0(분량, 본문 이력 0, 링크)
- python3 scripts/check-work-docs.py --links docs/manual docs/work
  링크 113개, 깨진 것 0
- ./gradlew :app-bootstrap:documentContractTest rc=0, 22개 클래스
  66건 통과, 실패·skip 0. docs/manual과 docs/work를 읽는 테스트는 없다
  (src의 Java·Gradle에서 파일 이름·폴더 경로 grep, 주석 2곳만 걸림)
- grep -e 리뷰 -e 라운드 -e 결정 docs/manual/*.md로 남은 줄을 읽었다.
  모두 날짜와 내용이 있는 문장이다
2026-11-07 00:25:32 +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 가 소유한다.