Files
clean-architecture-frontend…/docs
DongHyeonka 95141f1d85 docs(a11y): 한 자원 GET을 부르지 않는 라우트는 자기 paramsSchema를 둔다고 적는다
문제: 9c4cddc의 report는 "로그인 라우트의 paramsSchema = 한 자원 GET의
입력 스키마"만으로 실패 화면 기록을 기대한다. 그 라우트의 페이지가 그
GET을 실제로 부르는지는 보지 않는다. 손으로 쓴 기능이 하위 항목 작성 폼
(`/things/:thingId/parts/new`)의 paramsSchema로 상세 GET과 같은
ThingParams를 쓰면, spec은 한 자원 응답을 보지 못해 기록을 남기지 않고
report가 `a11y.json not written:`으로 FE-GATE-009를 실패시킨다. 그런데
errors.md는 "spec의 기록 호출을 본다. 기능 파일은 고치지 않는다"고만
안내했다. 이 경우 고칠 곳은 기능의 라우트 스키마 ID다.

고른 방법: 리뷰의 첫 방향. report 판정은 그대로 두고 안내를 고친다.
errors.md 행이 두 원인(spec이 기록을 놓침 / 페이지가 그 GET을 부르지
않음)과 각각 고칠 곳을 적는다. 매뉴얼 01 6단계에 같은 경우와 고치는 법
(그 라우트에 자기 paramsSchema)을 더했다. CHANGELOG 1106 절 11-01 행에
같은 줄을 더했다. report의 실패 문장 끝에도 같은 안내를 붙였다. 판정
조건과 문장 앞부분은 그대로라 단위 테스트의 기대(`stringContaining`)도
그대로다.
버린 대안: spec이 "기대했지만 보지 못함"을 따로 기록하고 report가 그
경우를 다르게 다룬다. report 판정이 바뀌어 이번 범위(문서) 밖이다.

위험·한계: 같은 스키마를 쓰면서 그 GET을 부르지 않는 라우트는 여전히
실패한다. 안내로만 풀린다. 그 라우트에 스키마를 따로 두면 FE-REG-SCHEMA
행과 route codec이 하나씩 는다.

검증: desktop batch에서 확인. 테스트 없음(문서와 실패 문장 끝).
corepack pnpm verify:documentation
node scripts/run-vitest.ts run tests/unit/a11y-report.test.ts
tests/unit/changelog-review-ids.test.ts

Refs: 1106/11-01 (diff review DR-05)
2026-11-06 07:59:04 +09:00
..

문서 색인

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 게이트, 테스트 계층, 새 프로젝트가 초기화할 기준선

입구 문서가 가리키는 세부 규칙:

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. 목표 설계

설계와 결정 기록이다. 구현된 부분과 계획이 한 문서에 섞여 있다. 행마다 상태 값을 본다.

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 리뷰 수정 라운드의 요구사항과 작업 목록. 그 라운드는 0.2.0(CHANGELOG.md)으로 끝났다. 그때 리뷰 문서(reviews/2026-09-25-maturity-review/)가 이 경로(SPEC.md:18 등)로 가리키므로 옮기지 않는다