번역 네 묶음(D2a~D2d)을 합친 트리는 문서만이 아니라 문서를 읽는 테스트의 기대 문구도 바꿨다. runbook 머리말 status 어휘(stub·active → 초안·운영), 루트 README의 「## 시작하기」, 알림 지원 매트릭스의 등급 칸 이름, 파일서버·JPA 문서의 한국어 제목과 문구, 패키지 소유 표의 머리 칸이다. 자기 runbook을 두었거나 그 문서를 고친 파생 서비스는 merge 뒤 mainCheck의 document-contract lane이 실패한다. 그런데 이것을 적은 안내가 없다. docs/README.md도 「아직 옮기지 않은 문서는 예외 목록에 있다」고 적어 지금(목록이 빔)과 맞지 않고, ADR 본문을 옮긴 사실이 「본문은 원문 그대로」라는 기록 규칙 설명과 부딪친다. - docs/upgrade/2026-11-docs-records.md에 4절(2단계)을 더했다. 할 일 다섯과, 기대 문구가 바뀐 문서·테스트 표다. 범위·「누가 읽나」·3절의 「본문은 원문 그대로」를 2단계에 맞게 고쳤다. - docs/README.md 「문서 수명과 언어」: 모두 옮겼고 예외 목록이 비었다, ADR 번역은 뜻을 바꾸지 않은 옮김이고 원문은 03a313ed에 있다. 「기록 문서의 머리 블록」: ADR만 본문을 옮겼다. 버린 대안: 새 업그레이드 문서를 따로 쓰기. 같은 날 같은 문서 체계 일의 두 단계이고, 옮긴 경로 표(2절)를 2단계의 ADR 이동과 함께 한 곳에서 찾게 하는 편이 낫다. 한계: ADR 머리 블록 둘째 줄 「본문은 결정한 때의 원문이다」는 고치지 않았다. 그 문구는 design-docs conventions/docs-system.md가 정하고 check-docs.py가 글자 그대로 본다. 바꾸려면 정본부터 바꿔야 한다. docs-check를 파생 서비스가 유지할지(docs/ci-cd/template-vs-consumer.md 분류)는 이 변경이 정하지 않는다. 검증(노트북): check-docs.py OK, 자기 시험 68 OK, check-work-docs.py OK. 안내의 테스트 이름·기대 문구는 각 테스트 소스에서 확인했다 (RunbookCoverageContractTest RUNBOOK_STATUSES, DeveloperExperience ContractTest, NotificationEvidenceVerifier GRADE_COLUMN_HEADER, NotificationReleaseGateTest, FileserverDocumentationCoverageTest, JpaDocumentationContractTest, TemplatePackageOwnershipDocumentTest).
14 KiB
docs
저장소의 모든 문서는 이 폴더 아래에 있다. 이 README는 두 가지를 정한다.
- 어떤 문서가 어느 폴더에 있나: 아래 「문서 지도」. 지금 있는 모든 문서 폴더를 덮는다.
- 문서의 수명에 따라 무엇을 어떤 언어로 고치나: 「문서 수명과 언어」.
파일 목록과 개수는 여기에 적지 않는다. 적으면 다음 문서가 더해지는 순간 틀린 글이 된다. 파일은 폴더를 직접 읽는다.
문서 지도
- 표의 첫 칸이 폴더다(
docs/기준 경로). - 새 문서 폴더를 만들면 같은 변경에서 이 지도에 행을 더한다. 폴더를 지우거나 옮기면 그 행도 고친다.
python3 scripts/check-docs.py의map검사가 지도에 없는 폴더와, 지도에 있지만 없는 폴더를 막는다(「문서 검사」).
매뉴얼
일하는 순서와 판단 지점이다. 사람과 AI 세션이 같이 쓴다.
| 폴더 | 무엇 |
|---|---|
work/ |
작업 매뉴얼: 이 repo에서 하는 일(새 기능, 개선, 조사·설계, 문서 작성, 운영, 일 나누기)의 절차서. 루트 CLAUDE.md 다음에 읽는다 |
manual/ |
개발 매뉴얼: 새 기능을 만드는 순서와 판단 지점, 생성 명령(scripts/new-feature.sh). 입구는 work/new-feature.md |
testing/ |
테스트 전략: 테스트 종류 다섯, source set, 어떤 테스트를 어디에 두나, Gradle 실행 계층 |
계약과 스냅숏
코드와 테스트가 대조하는 정본이다. 바꾸면 공개 계약이 바뀔 수 있다(work/README.md 2절).
| 폴더 | 무엇 |
|---|---|
registries/ |
레지스트리: env 키, 오류 코드, 메트릭, HTTP 헤더, 로그(MDC) 키, 비밀 분류, use case capability, 객체 저장소 준비도. 테스트가 코드와 대조한다 |
web/ |
HTTP wire 계약(web/http-contract.md), PATCH·스트리밍 계약, 선택형 web 기능(web-advanced), web 장애 대응 |
architecture/ |
공개 API 표면 스냅숏(*-api-surface.txt). API surface 검사가 대조한다 |
security/ |
기본 공개 경로 스냅숏. verifyPublicPathSnapshot이 대조한다 |
observability/ |
구조화 로그 필드 사전 |
compatibility/ |
gRPC 플랫폼 지원 매트릭스(무엇에 대해 인증했고 무엇은 지켜보기만 하나) |
영역 운영 문서
capability(부가 기능) 하나의 지원 범위, 설정, 보안, 운영, 마이그레이션이다. 코드와 같은 변경에서 고친다.
httpclient/는 scripts/verify-httpclient-docs.py가 코드에서 뽑은 이름과 대조한다.
| 폴더 | 무엇 |
|---|---|
fileserver/ |
파일 서버 |
httpclient/ |
외부 HTTP 호출(HTTP client 플랫폼) |
jpa/ |
JPA·PostgreSQL 영속성 |
messaging/ |
메시징 adapter |
mongodb/ |
MongoDB 문서 영속성 |
mongodb/advanced/ |
MongoDB 고급 기능(암호화, 멀티 테넌시, 샤딩). 설정 키가 아니라 라이브러리 API로 켠다 |
mongodb/runbooks/ |
MongoDB 장애 대응 |
mongo/ |
MongoDB 영속성 설정 예시 파일(Spring이 읽지 않는 예시) |
notification/ |
알림 전달 플랫폼 |
objectstorage/ |
객체 저장소의 설정 필드와 env 이름 표(env-fields.yaml) |
redis/ |
Redis 캐시·세션 |
websocket/ |
WebSocket handler 장애 대응 |
운영과 전달
| 폴더 | 무엇 |
|---|---|
runbooks/ |
오류 코드별 장애 대응 런북(runbooks/template.md 형식) |
ci-cd/ |
CI/CD 경계: 검증·빌드(CI)와 배포(CD)의 경계, 템플릿과 파생 서비스가 각각 돌릴 검증 |
upgrade/ |
파생 서비스용 변경 안내: 템플릿 변경을 받을 때 서비스가 할 일 |
roadmap/ |
아직 구현하지 않은 다음 단계와 그 조건 |
결정 기록
| 폴더 | 무엇 |
|---|---|
adr/ |
결정 기록(ADR). 영역마다 파일 이름 앞머리가 다르다(ADR-JPA-, NOTIF-ADR- 등) |
설계와 기록
설계서와 기록은 쓴 때의 글이다. 지금 동작을 설명하지 않는다. 그래서 살아 있는 문서와 다른 폴더에 둔다.
| 폴더 | 무엇 |
|---|---|
design/ |
설계서. YYYY-MM-DD-<주제>-design.md |
history/plans/ |
구현·확장 계획서. YYYY-MM-DD-<주제>-plan.md |
history/packages/ |
외부에서 납품된 설계 패키지의 README와 정적 검증 결과 |
history/evidence/ |
작업 단계별 증거·체크포인트 |
history/study/ |
학습 문서. 쓴 때의 코드를 따라 읽은 기록이다 |
reviews/ |
코드 리뷰 결과. 라운드마다 폴더 하나(README가 결정과 남은 것을 적는다) 또는 리뷰 문서 하나 |
history/packages/<어댑터>/는 설계서가 처음 전달됐을 때의 안내와 VALIDATION.md 검증 이력을
남긴 기록 보관소다. 설계서·계획서 본문은 전부 design/과 history/plans/에 있으므로 이 폴더에서
문서를 찾을 필요는 없다. 각 README 상단의 보존 안내가 무엇이 옮겨졌고 무엇이 제거됐는지 밝힌다.
history/packages/*-superpowers-package/ 셋은 납품된 묶음 그대로이고, 그 안의 MANIFEST.sha256은
납품 당시 바이트의 해시다.
계획서 본문에는 당시 계획한 경로와 명령이 그대로 남아 있다. 그중 일부는 실제 구현에서 다른 위치로
조정됐고, 저장소에 어떻게 대응시켰는지는 각 어댑터의 repository-adaptation.md 또는
module-mapping.md가 기록한다. 계획서를 나중에 고치지 않는 이유는 그렇게 하면 계획의 기록이 아니라
결과를 계획처럼 보이게 만든 글이 되기 때문이다.
폴더 밖 문서
| 문서 | 무엇 |
|---|---|
| capability-status.md | capability마다 코드가 있나·조립되나·실제 제공자로 검증됐나, 그리고 지운 코드의 표(「제거된 코드」) |
| storage-capability-boundary.md | 파일 서버와 객체 저장소가 각각 맡는 경계 |
문서 수명과 언어
규칙의 정본은 design-docs conventions/docs-system.md다. 이 절은 이 repo에 적용한 내용이고,
이 템플릿을 받은 파생 서비스도 이 절을 따른다.
| 수명 | 문서 | 위치 | 언어 | 고치는 법 |
|---|---|---|---|---|
| 살아 있음 | README, CLAUDE.md, AGENTS.md, 매뉴얼(manual/, work/), 영역 운영 문서, registries/, runbooks/, upgrade/ |
제자리 | 한국어 | 코드와 같은 변경에서 고친다 |
| 결정 | 결정 기록(ADR) | adr/ |
한국어 | 본문은 고치지 않는다. 일부가 바뀌면 상태를 「채택(보완)」으로 하고 보완 절을 덧붙인다. 크게 바뀌면 새 ADR을 쓰고 옛 ADR을 「대체됨」으로 한다 |
| 기록 | 설계서, 계획서, 납품 패키지, 증거, 학습 문서, 리뷰 | design/, history/, reviews/ |
머리 블록은 한국어, 본문은 쓴 때의 원문 | 머리 블록의 칸만 고친다 |
- 코드 식별자, 명령, 경로, 설정 키, 오류 코드, 로그·출력 인용, 제품 이름은 원문으로 둔다.
- 문체는 「~한다」다. 한 문서 안에서 「~합니다」와 섞지 않는다.
- 살아 있는 문서와 ADR 본문은 2026-11-07에 모두 한국어로 옮겼다. 문서 검사의 예외 목록은 비어 있다(「문서 검사」).
- ADR 본문의 번역은 뜻을 바꾸지 않은 옮김이다. 옮기기 전 원문은 커밋
03a313ed에 있다(알림 ADR은 그때 다른 폴더에 있었다. 옛 경로는docs/upgrade/2026-11-docs-records.md).
기록 문서의 머리 블록
design/, history/, adr/의 .md 파일은 맨 위에 이 블록을 둔다.
블록을 빼면 원문 그대로다(옮길 때 깨진 상대 링크의 대상만 고쳤다). ADR만은 본문을 한국어로 옮겼다(「문서 수명과 언어」).
<!-- 머리 블록: 이 블록을 빼면 원문이다. 형식은 docs/README.md 「기록 문서의 머리 블록」 -->
> **기록 · 설계서** 본문은 쓴 때의 원문이다. 지금 동작은 「현재 정본」을 읽는다.
- 상태: 구현됨
- 작성일: 2026-08-11
- 요약: 한국어 한 문장
- 현재 정본: `docs/jpa/repository-adaptation.md`
- 대체됨: `docs/design/<대체한 문서>.md`
<!-- 머리 블록 끝 -->
-
종류는 폴더가 정하고 둘째 줄에 굵게 적는다:
design/설계서,history/plans/계획서,history/evidence/·history/plans/evidence/증거,history/packages/납품 패키지,history/study/학습 문서. ADR의 둘째 줄은> **결정 기록** 본문은 결정한 때의 원문이다. 지금도 유효한지는 「상태」를, 지금 동작은 「현재 정본」을 읽는다.다. -
상태는 종류마다 고정 어휘다.
종류 상태 설계서 제안 · 채택 · 구현됨 · 보류 · 폐기 · 대체됨 · 확인 안 함 결정 기록 제안 · 채택 · 채택(보완) · 폐기 · 대체됨 계획서 실행 중 · 끝남 · 중단 · 대체됨 · 확인 안 함 납품 패키지 · 증거 · 학습 문서 보관 -
「현재 정본」은 지금 동작을 설명하는 살아 있는 문서의 경로다. 여럿이면 쉼표로 잇고, 없으면 「없음 — 이유」로 쓴다.
-
「대체됨」은 상태가 대체됨일 때 대체한 문서의 경로다. 이 문서가 다른 문서를 대체했으면 「대체」 칸에 그 경로를 쓴다.
-
상태는 그 결정을 바꾼 변경이 같이 바꾼다. 기능을 지우는 커밋이 그 기능의 설계서를 「폐기」나 「대체됨」으로 바꾼다.
-
2026-11-07에 처음 단 상태는 문서의 원래 상태 줄을 바꾼 값이다: Accepted·Approved·확정·승인 → 채택, Superseded → 대체됨, Proposed → 제안, implemented → 구현됨, 보완 메모가 있는 ADR → 채택(보완). 상태 줄이 없던 설계서와 체크 상자가 모두 표시되지 않은 계획서는 「확인 안 함」이다.
capability-status.md「제거된 코드」로 지운 것이 확인된 설계서 다섯은 「폐기」다. -
리뷰(
reviews/)는 아직 머리 블록을 요구하지 않는다.
문서와 코드를 같은 변경에서 고친다
- 코드나 규칙을 바꾸는 변경이 그것을 설명하는 살아 있는 문서도 고친다. 찾는 법:
grep -rn '<바꾼 이름>' docs src --include=*.md. - 살아 있는 문서는 지금 있는 것만 쓴다. 지운 타입·경로·태스크는
capability-status.md「제거된 코드」나upgrade/에 쓴다. 살아 있는 문서 안에서 꼭 써야 하면> 이력으로 시작하는 인용 블록 안에 쓴다. - 숫자·버전을 복사하지 않는다. Spring Boot 버전은
src/gradle/libs.versions.toml, leaf 목록과 개수는 registry(src/config/architecture/modules.json)를 가리킨다. - 루트 README는 「프로젝트 구조」(최상위 폴더와
src/폴더가 하는 일)와 「문서 지도」(매뉴얼·계약·운영·결정·기록이 어디 있나) 절을 반드시 둔다. 전체 절 목록과 순서의 정본은 design-docsconventions/docs-system.md6.1절이고,readme검사가 그 목록(scripts/check-docs.py의README_SECTIONS)을 본다.
문서 검사
python3 scripts/check-docs.py가 위 규칙 중 기계로 볼 수 있는 여섯을 본다. PR마다 workflow docs-check가
돌리고, 하나라도 걸리면 실패한다. 경로 필터가 없다: 코드에서 파일이나 Gradle 프로젝트를 지우는 변경이
문서를 낡게 만든다.
| 검사 | 보는 것 |
|---|---|
language |
살아 있는 문서와 ADR 본문이 한국어인가(코드·명령·경로·인용은 세지 않는다) |
head |
기록과 ADR 맨 위의 머리 블록: 칸, 상태 어휘, 날짜, 한국어 요약, 현재 정본·대체됨 경로가 있는지 |
reference |
살아 있는 문서의 인라인 코드 안 경로(src/, docs/, scripts/, compose/, .github/로 시작하는 것과 지운 infra 폴더 아래 경로)와 Gradle 경로가 지금 트리·registry에 있는가. 코드 블록, > 이력 인용 블록, 제거 표, upgrade/는 보지 않는다 |
number |
살아 있는 문서가 Spring Boot 버전이나 leaf 개수를 복사했는가 |
map |
이 README의 「문서 지도」가 docs/ 아래 모든 폴더를 덮는가(표 첫 칸의 폴더/). 파일 없이 폴더만 가진 묶음 폴더(history/)는 그 바로 아래 폴더가 대신한다. 지도에 있지만 없는 폴더도 실패다 |
readme |
루트 README가 첫 줄 제목, 그 아래 한 문단, 정해진 ## 절을 정해진 순서로 가지는가 |
- 하나만 돌리기:
python3 scripts/check-docs.py --only head. - 소스 세트의 resources 폴더 아래
.md(src/**/src/<세트>/resources/)는 테스트가 읽는 입력이라 문서로 보지 않는다. - 예외 목록
scripts/check-docs-exceptions.txt는 2026-11-07의 기준선이고 줄기만 한다. 문서를 번역하거나 고쳐서 더는 걸리지 않으면 그 줄을 지운다(남겨 두면 실패한다). 목록에 새 줄을 더하면 실패한다. 기준선을 늘리는 것은 규칙을 바꾸는 일이라 소유자 결정이 필요하다. - 줄을 지우면 같은 변경에서
scripts/check-docs.py의FROZEN에서 그 줄의 지문도 뺀다. 남겨 두면 실패한다(남은 지문은 지운 줄을 다시 더하는 길이다). 2026-11-07 번역 단계에서 목록과FROZEN이 모두 비었다. - 검사 자신의 시험:
python3 -m unittest discover -s scripts/tests. - 마크다운 링크는 이 검사가 아니라 lychee(
link-checkworkflow)와scripts/check-work-docs.py --links가 본다. 기록 안의 외부 링크가 죽어도 기록 본문은 고치지 않는다. 그 URL을 저장소 루트의.lycheeignore에 더한다.
여기에 없는 것
- 실행되는 검증 스크립트는 문서가 아니다.
scripts/와.github/scripts/에 있다. - 모듈 레지스트리·Gradle 정책은
src/config/architecture/modules.json과src/build.gradle이 소유한다. - 각 모듈의 지역 규칙은 해당 모듈의
src/**/CLAUDE.md가 소유한다.