문제: docs/ 바로 아래에 매뉴얼·운영 문서와 쓴 때의 기록(계획서·설계서·
납품 패키지·증거·학습)이 같은 층에 섞여 있다. 기록이라는 표시도 없어
읽는 사람이 지금 동작을 설명하는 문서와 구분하지 못한다.
고른 방법: 2026-11-07 소유자가 승인한 수명 기준 분리를 따른다.
- docs/superpowers/specs → docs/design/
- docs/superpowers/plans → docs/history/plans/
- docs/superpowers/packages/* → docs/history/packages/*
- docs/{graphql,web,websocket}-superpowers-package
→ docs/history/packages/<같은 이름>/ (packages/graphql과 겹치지 않게
원래 폴더 이름을 둔다)
- docs/evidence → docs/history/evidence/, docs/study → docs/history/study/
- git에 들어가 있던 __pycache__ .pyc를 지우고 .gitignore에 더한다.
옮긴 경로를 가리키는 줄을 같은 커밋에서 고쳤다: 살아 있는 문서의 인라인
경로, AGENTS.md·CLAUDE.md, 빌드 스크립트·테스트 주석, docs/README.md 위치
표, 파생 서비스용 docs/upgrade/2026-11-docs-records.md. 기록 본문은
고치지 않고, 이동으로 깨진 마크다운 상대 링크 32개의 대상만 고쳤다(lychee와
check-work-docs.py --links가 docs/** 전체를 본다). 이동만 따로 두면 그
커밋에서 링크 검사가 실패하므로 한 커밋으로 묶었다. 대부분 R100이라 이름
바뀜은 그대로 보인다.
위험·한계: 기록 본문과 docs/reviews/** 안의 인라인 코드 경로는 옛 경로로
남는다(기록은 고치지 않는다). 실험용 Flyway 파일
db/experimental-rls/V1__tenant_rls.sql의 주석은 체크섬이 바뀌므로 두었다.
납품 패키지 셋의 MANIFEST.sha256과 validate_*.py는 패키지 안 상대 경로라
이동 뒤에도 그대로다.
검증: python3 scripts/check-work-docs.py rc=0, --links(gates.md 범위 +
CLAUDE.md·AGENTS.md) 581개 파일 깨진 링크 0, --history docs/manual rc=0.
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 |
registries/ |
env 키·에러 코드·메트릭·헤더 등 레지스트리 SSOT |
reviews/ |
모듈 코드 리뷰 결과 |
runbooks/ |
장애 코드별 대응 런북 (template.md 기준) |
security/ |
공개 경로 스냅숏 |
설계와 기록
설계서와 기록은 쓴 때의 글이다. 지금 동작을 설명하지 않는다. 그래서 살아 있는 문서와 다른 폴더에 둔다.
| 디렉터리 | 대상 |
|---|---|
design/ |
설계서. YYYY-MM-DD-<주제>-design.md |
history/plans/ |
구현·확장 계획서. YYYY-MM-DD-<주제>-plan.md |
history/packages/ |
외부에서 납품된 설계 패키지의 README와 정적 검증 결과 |
history/evidence/ |
작업 단계별 증거·체크포인트 |
history/study/ |
학습 문서. 쓴 때의 코드를 따라 읽은 기록이다 |
history/packages/<어댑터>/ 는 설계서가 처음 전달됐을 때의 안내와 VALIDATION.md 검증 이력을
남긴 기록 보관소다. 설계서·계획서 본문은 전부 design/ 과 history/plans/ 에 있으므로 이 디렉터리에서
문서를 찾을 필요는 없다. 각 README 상단의 보존 안내가 무엇이 옮겨졌고 무엇이 제거됐는지 밝힌다.
history/packages/*-superpowers-package/ 셋은 납품된 묶음 그대로이고, 그 안의 MANIFEST.sha256 은
납품 당시 바이트의 해시다.
계획서 본문에는 당시 계획한 경로와 명령이 그대로 남아 있다. 그중 일부는 실제 구현에서 다른 위치로
조정됐고, 저장소에 어떻게 대응시켰는지는 각 어댑터의 repository-adaptation.md 또는
module-mapping.md 가 기록한다. 계획서를 사후에 고치지 않는 이유는 그렇게 하면 계획의 기록이 아니라
결과를 계획처럼 보이게 만든 글이 되기 때문이다.
여기에 없는 것
- 실행되는 검증 스크립트는 문서가 아니다.
scripts/와.github/scripts/에 있다. - 모듈 레지스트리·Gradle 정책은
src/config/architecture/modules.json과src/build.gradle이 소유한다. - 각 모듈의 지역 규칙은 해당 모듈의
src/**/CLAUDE.md가 소유한다.