문제: src/platform·src/apps·src/contexts의 구조·소유·예산·실행· 텔레메트리 규칙과 코드 주석 "Spec §N"의 근거가 2026-09-23 설계서 하나에만 있다. 그 설계서는 docs/reviews/ 안의 계획 묶음에 들어 있어 README가 복사 뒤 지워도 된다고 한 범위 안이다. 현재 계약 목록 (docs/README.md §1)에는 src/platform을 다루는 문서가 없다. 고른 방법: 설계서를 docs/architecture/scale-architecture.md로 복사한다 (git mv가 아니라 복사라 이력 묶음은 그대로 남는다). 본문 §1~§55는 영어 원문 그대로 두고 절 번호를 바꾸지 않는다. 맨 위에 상태 머리말을 붙인다: 현재 계약인 범위, 출처(커밋 6f6c48e와 원래 경로, git show로 보는 법), 코드와 달라진 곳을 절 끝 "> 2026-11-03 현재:"로 적는 규칙. 절 상태 표는 현재 계약(코드 참조) 41, 현재 계약 10, 기록만 4 (§40·§51·§53·§54), 미확인 0이다. 코드와 다른 18개 절에 차이를 한두 줄로 적었다(예: §4 최상위 domain/ 없음, §11 TrafficBudget에 deadline 없음, §40 부팅 게이트 없음, §47 CI는 pr 단계만). docs/README.md §1의 세부 규칙 목록에 새 문서를 더한다. 버린 대안: 필요한 절만 새로 쓰기. 68곳 넘는 주석의 절 번호 대응표가 필요해지고 원문과 갈라진다. 이력을 지우지 말라고 정책을 바꾸기 (리뷰 5.1절 (c)). 동기화 비용과 문서 섞임이 그대로 남는다. 위험·한계: 절 대조는 각 절을 가리키는 모듈의 타입·머리 주석·테스트 이름을 읽는 수준이다. 동작을 실행해 확인하지 않았다. 원문의 "Status: Design approved…"와 예정 경로 줄은 머리말로 바꿨다. 예정 경로가 없는 파일을 가리켜 verify:documentation의 경로 검사에 걸리기 때문이다. 이 커밋만으로는 코드 주석이 아직 이름 없는 "Spec §N"이다. 다음 커밋이 바꾼다. 검증: - 본문 비교: 원문 §1 이후와 새 문서 §1 이후의 diff에서 지운 줄 0, "> 2026-11-03 현재" 메모 외에 더한 줄 0 - node scripts/verify-documentation-readiness.ts: PASS_SCOPED (처음 "src/domain"을 백틱으로 적어 FAIL, 문구를 고쳐 PASS) - node scripts/run-vitest.ts run tests/unit/documentation-readiness.test.ts tests/unit/deletable-history-documents.test.ts: 15 passed
문서 색인
docs/의 문서를 세 묶음으로 나눈다.
1. 현재 계약 지금 코드가 지키는 규칙. 게이트가 검사한다
2. 목표 설계 앞으로의 설계와 결정. 구현됐다는 뜻이 아니다
3. 작업 이력 리뷰·계획·작업 추적. 복사한 프로젝트는 지워도 된다
문서와 코드가 다르면 코드가 맞다. 목표 설계 문서에 적힌 기능이 지금 동작하는지는
문서 안의 상태 값(COMPOSED, AVAILABLE_NOT_COMPOSED, DESIGNED_NOT_IMPLEMENTED 등)으로
확인한다. 상태 값의 뜻은 README.md의 "Support scope" 절에 있다.
README와 입구 문서는 영어, recipe·ledger·스타일 문서는 한국어다.
1. 현재 계약
처음 읽을 입구 문서 6개다.
| 문서 | 정하는 것 |
|---|---|
README.md |
시작, 런타임 설정과 배포 변수, 검증 명령, CI, 지원 범위, 원본 업데이트 반영 |
architecture/frontend-application-foundation.md |
이 repo의 역할(스타터 + 재사용 capability)과 기본·선택의 경계 |
architecture/layers.md, architecture/overview.md |
계층과 import 방향. check:architecture가 검사한다 |
architecture/starter-experience.md |
기본 라우트, 인증 모드, 기능 추가·제거 절차 |
architecture/optional-adapter-recipes.md |
선택 기능(recipe)을 넣고 빼는 절차 |
operations/ci-quality-gates.md, testing/taxonomy.md |
게이트, 테스트 계층, 새 프로젝트가 초기화할 기준선 |
입구 문서가 가리키는 세부 규칙:
- 규모 설계(구조·소유·실행·트래픽·오류·검증·텔레메트리·릴리스 일관성)와 코드 주석
scale-architecture.md §N의 근거:architecture/scale-architecture.md. 절마다 현재 계약인지 기록만인지 머리말 표에 적었다 - 계약 소유와 호환성:
architecture/contract-ownership.md,contracts/compatibility.md - 정적 배포와 런타임 설정:
architecture/static-delivery.md - 기능 개발자가 알아야 하는 양:
architecture/capability-consumer-experience.md - 운영·복구:
operations/,runbooks/ - 보안과 공급망:
security/browser-boundary.md,security/supply-chain.md - 디자인 토큰과 수동 접근성 검토:
styling/design-tokens.md,accessibility/manual-checklist.md - 버전별 변경:
../CHANGELOG.md
verify:documentation은 이 파일과 이 절에서 링크한 문서(폴더 링크는 그 안의 .md 전부)에
적힌 repo 경로·링크·package script·FE-GATE ID가 실제로 있는지 검사한다. CHANGELOG.md는
지난 상태를 적는 문서라 빼고, git이 무시하는 생성 산출물과 복사한 프로젝트가 지운 작업 이력은
없어도 된다. 설명·수치가 코드와 맞는지는 검사하지 않는다. 규칙과 예외의 정본은
scripts/verify-documentation-readiness.ts다.
게이트가 직접 읽는 파일이라 지우거나 옮기면 게이트가 실패한다.
| 파일 | 읽는 명령 |
|---|---|
이 파일, architecture/review-ledger.json, architecture/review-evidence.md |
verify:documentation (FE-GATE-017) |
repo 루트의 artifacts/tests/a11y-manual/ 라우트별 기록 |
verify:documentation (FE-GATE-017), review:a11y-manual (FE-GATE-009, FE-GATE-028) |
reviews/adapters/INVENTORY.md |
check:adapter-inventory (FE-GATE-010) |
operations/adapter-remediation-ledger.md, operations/adapter-remediation-dispositions.json |
check:remediation-ledger (게이트 밖. 이유는 config/ci/ungated-scripts.json) |
2. 목표 설계
설계와 결정 기록이다. 구현된 부분과 계획이 한 문서에 섞여 있다. 행마다 상태 값을 본다.
- 런타임 capability 결정의 정본:
architecture/2026-07-30-frontend-runtime-capability-repository-aligned-implementation-closed-deep-design.md - 상태 원장:
architecture/browser-data-capability-completion-ledger.md - 전체 검토와 로드맵:
architecture/frontend-platform-capability-review.md,architecture/frontend-platform-implementation-roadmap.md - 포트·경계·데이터 흐름:
architecture/frontend-ports-adapters-and-boundaries.md,architecture/typescript-state-and-data-flow.md,architecture/routing-pages-and-patterns.md - API와 서버 상태:
architecture/api-contract-schema-mapper-and-server-state.md,architecture/backend-api-and-server-state-contract.md,architecture/protobuf-browser-transport-and-rest-gateway.md - 브라우저 데이터:
architecture/client-cache-and-storage.md,architecture/browser-file-and-origin-storage.md,architecture/presigned-transfer-and-image-cdn.md,architecture/server-file-capability-infrastructure.md - 실시간:
architecture/realtime-events-web-push-and-bounded-polling.md - 디자인 시스템과 테스트 전략:
styling/design-system-platform.md,testing/frontend-platform-testing-strategy.md - 결정 기록(ADR):
architecture/decisions/VD-*.md
3. 작업 이력·리뷰
템플릿을 만들면서 쓴 계획, 리뷰, 작업 추적이다. 현재 계약이 아니다.
복사한 프로젝트는 지워도 된다. 지울 때 남길 파일은 README.md의
"Files you can delete after copying" 절에 있다.
| 경로 | 내용 |
|---|---|
superpowers/ |
과거 작업 계획과 스펙 |
reviews/ |
리뷰 결과와 리뷰 가이드. reviews/adapters/INVENTORY.md만 게이트가 읽는다 |
../SPEC.md, ../tasks/ |
2026-09-25 리뷰 수정 라운드의 요구사항과 작업 목록. 이 라운드가 쓰는 중이라 docs/ 밖에 그대로 둔다 |