문제 CHANGELOG "먼저 할 일" 6단계는 예제를 지운 제품(tech-log)에게 예제 기능 폴더와 그 context를 지우라고 한다. 그런데 starter-experience.md가 그 세 폴더를 백틱 경로로 적어서, 지운 사본에서 verify:documentation과 FE-GATE-005의 documentation-readiness "passes the documents as they are"가 "starter-experience.md names paths that do not exist"로 실패한다(리뷰 14-R1). 그 문서가 안내한 드릴(test:sample-removal --feature=platform-examples-feature)도 같은 문서 검사와, 예제 기능 ID를 적은 tests/unit/hosting-probe.test.ts 때문에 잔여 검사에서 실패한다. PRODUCT.md는 예제 화면에 제거 드릴이 없다고 적는다. 지운 제품이 템플릿 문서를 고치면 동기화마다 그 줄이 충돌한다. 고른 방법 - 문서 검사는 scripts/lib/removable-template-features.ts의 기능마다, 그 기능이 설치돼 있으면(src/features/<id>/feature-module.ts가 있으면) 그 경로·script를 지금처럼 검사하고, 아니면 그 기능이 가진 경로(기능·테스트 폴더, context, 전용 파일)와 script를 없어도 되는 것으로 본다. 폴더가 아니라 feature-module.ts를 보는 것은 tech-log가 참조 기능 폴더를 계약 파일만 남긴 채 NOT_A_FEATURE로 두기 때문이다(CHANGELOG 옮기는 법 1). 목록에 없는 폴더(오타)는 그대로 실패한다. 지운 기능이 있으면 stdout에 그 ID를 적는다. - tests/unit/hosting-probe.test.ts의 FEATURE_OVERRIDES 키를 테스트 전용 기능 ID(fixture-feature)로 바꾼다. probe는 키 이름을 보지 않는다. - 새 테스트 tests/unit/template-feature-removal-documents.test.ts: 저장소 사본에서 기능마다 그 경로를 지우고 색인을 다시 만든 뒤 사본의 verify:documentation이 통과한다. 사본의 코드로 경로를 찾으므로 실제로 지운 상태다. 기능 ID는 목록에서 읽어 테스트에 적지 않는다(제거 드릴의 잔여 검사). 설치된 기능 아래의 없는 경로와 목록에 없는 폴더는 여전히 실패하는 것도 본다. 문서를 읽으므로 REMOVAL_FIXTURE_DOCUMENT_TESTS에 더했다. - PRODUCT.md, starter-experience.md(지우는 법과 문서 검사 규칙), docs/README.md 1절 검사 설명, CHANGELOG 6단계(테스트 폴더, generate:feature-index, 드릴, 두 절을 함께 받을 것)를 고쳤다. - 버린 대안: (a) 세 경로를 백틱 없이 적기(1103/14-04 방식). 검사가 또 좁아진다(1105/14-03). (b) 모든 src/features/<dir> 아래 경로를 폴더가 없으면 통과시키기. 기능 폴더 이름 오타가 조용히 지나간다. (c) FE-GATE-020에 예제 기능 드릴을 더하기. job이 약 5분 는다. 문서 쪽은 새 unit 테스트가 merge 단계에서 본다. 위험·한계 - 새 테스트는 저장소 사본을 두 번 만든다(기능마다 cp·색인·검사). test:unit 시간이 몇 초 는다. 드릴이 test:all에서 이 파일을 다시 돈다. - 예제 기능 드릴 전체(test:all, build 등)는 이 커밋에서 돌리지 않았다. 알려진 남은 실패는 e2e·visual spec이 예제 화면을 여는 것이고 드릴 밖이다. - RED에서 새 테스트는 앞 커밋의 목록 모듈을 import하므로 그대로 돈다. 검증 - desktop batch에서 확인: node scripts/run-vitest.ts run tests/unit/template-feature-removal-documents.test.ts tests/unit/hosting-probe.test.ts tests/unit/removal-fixture.test.ts tests/unit/documentation-readiness.test.ts, corepack pnpm verify:documentation, corepack pnpm test:sample-removal -- --feature=platform-examples-feature Refs: 1105/14-01
8.8 KiB
문서 색인
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 |
게이트, 테스트 계층, 새 프로젝트가 초기화할 기준선 |
입구 문서가 가리키는 세부 규칙:
- 새 기능 추가 매뉴얼(작업 순서, 단계별 판단 기준,
create:feature):manual/,manual/reference/. 한국어다 - 규모 설계(구조·소유·실행·트래픽·오류·검증·텔레메트리·릴리스 일관성)와 코드 주석
scale-architecture.md §N의 근거:architecture/scale-architecture.md. 절마다 현재 계약인지 기록만인지 머리말 표에 적었다 - 계약 소유와 호환성:
architecture/contract-ownership.md,contracts/compatibility.md - 짝 백엔드 Envelope 판정과 쓰기 전 거절 표(지금 실행 규칙,
src/adapters/http/backend-envelope.ts의 근거):architecture/backend-api-and-server-state-contract.md4.1·6·6.1절. 기준 커밋은../config/contracts/backend-contract-pin.json. 같은 문서의 나머지 절은 목표 설계다 - 정적 배포와 런타임 설정:
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가 실제로 있는지 검사한다. 명령(인라인 코드와
셸 코드 블록) 안의 경로 인자도 본다. 짝 백엔드 템플릿(clean-architecture-backend-template)의
경로와 링크는 config/contracts/backend-contract-pin.json이 고정한 커밋의 트리에서 찾는다.
이 checkout 옆에 있는 짝 checkout의 git 기록을 읽고, 그 작업 트리와 HEAD는 보지 않는다. 짝
checkout이 없거나 그 커밋이 없으면 실패 대신 확인하지 못한 것으로 출력과
artifacts/quality/documentation-review.json에 남긴다. repo 밖으로 나가는 링크가 짝 저장소를
가리키지 않으면(저장소 이름 오타 포함) 실패한다. CHANGELOG.md는
지난 상태를 적는 문서라 빼고, git이 무시하는 생성 산출물과 복사한 프로젝트가 지운 작업 이력은
없어도 된다. 설명·수치가 코드와 맞는지는 검사하지 않는다. 규칙과 예외의 정본은
scripts/verify-documentation-readiness.ts다.
복사한 프로젝트가 지울 수 있는 템플릿 기능(참조 기능, 예제 화면. 목록은
scripts/lib/removable-template-features.ts)의 경로와 script는 그 기능이 설치돼 있을 때
(src/features/<id>/feature-module.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만 게이트가 읽는다. reviews/adapters/는 지우지 않는다: INVENTORY의 행과 operations/adapter-remediation-ledger.md가 그 안의 리뷰로 링크한다 |
../SPEC.md, ../tasks/ |
2026-09-25 리뷰 수정 라운드의 요구사항과 작업 목록. 이 라운드가 쓰는 중이라 docs/ 밖에 그대로 둔다 |