Files
clean-architecture-frontend…/docs
DongHyeonka 3b7d73ab37 docs(contract): 계약 4.1·6절이 백엔드 http-contract.md를 가리킨다 (백엔드 1101/02-01)
문제
docs/architecture/backend-api-and-server-state-contract.md 4.1절(JSON
envelope)과 6절(Command와 idempotency)이 백엔드 계약을 직접 다시 적었다.
짝 백엔드가 바뀐 뒤 둘이 어긋난다.
- 4.1절 예시는 meta id를 늘 싣고 null 생략 규칙이 없다.
- 6절은 같은 키·다른 본문을 409 IDEMPOTENCY_KEY_REUSED로 적는다. 백엔드는
  422 IDEMPOTENT_REQUEST_MISMATCH다. 처리 중 409의 retryable·Retry-After,
  400 IDEMPOTENCY_KEY_INVALID도 없다.
- 4.2절 409 행이 "idempotency fingerprint" 충돌을 409로 적는다.
백엔드 http-contract.md 5절은 이 두 절이 자기 문서를 가리켜야 한다고
적는다.

고른 방법
- 4.1절·6절의 표와 예시를 지우고 백엔드 문서 링크(1절, 2절·4절)와 기준
  버전(백엔드 리뷰 2026-11-01 15절 결정, 2026-11-03)만 적는다. 백엔드
  변경은 아직 커밋이 없어 SHA 대신 결정 날짜를 적고, 커밋이 생기면 SHA로
  바꾸라고 적었다.
- 프론트가 그 계약을 읽는 코드 위치만 남긴다. 표를 복사하지 않는다.
- 4.2절 409 행에서 멱등성 충돌을 빼고 6절을 가리킨다.

버린 대안
- 프론트 문서의 표를 백엔드 값으로 고쳐 두기: 다음 백엔드 변경에서 다시
  어긋난다.

위험·한계
- 링크는 두 repo가 같은 상위 폴더에 나란히 있을 때만 열린다
  (../../../clean-architecture-backend-template/...). verify:documentation은
  repo 밖 링크를 검사하지 않는다.
- 6절에서 지운 권장 IdempotencyRecord와 불변조건은 짝 백엔드가 구현과
  문서로 소유한다. 다른 백엔드를 붙이는 제품은 백엔드 문서를 기준으로 삼는다.
- 4.2절의 422 행(field validation)은 그대로다. 짝 백엔드는 필드 검증
  실패를 400 VALIDATION_FAILED로 보낸다(백엔드 http-contract.md 4절). 이
  차이는 이 변경 범위 밖이다.

검증
- node scripts/verify-documentation-readiness.ts: PASS_SCOPED.

Refs: clean-architecture-backend-template docs/web/http-contract.md 5절, docs/reviews/2026-11-01-maturity-review/README.md 14.3
2026-11-03 02:00:45 +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가 실제로 있는지 검사한다. 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. 목표 설계

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

3. 작업 이력·리뷰

템플릿을 만들면서 쓴 계획, 리뷰, 작업 추적이다. 현재 계약이 아니다. 복사한 프로젝트는 지워도 된다. 지울 때 남길 파일은 README.md의 "Files you can delete after copying" 절에 있다.

경로 내용
superpowers/ 과거 작업 계획과 스펙
reviews/ 리뷰 결과와 리뷰 가이드. reviews/adapters/INVENTORY.md만 게이트가 읽는다
../SPEC.md, ../tasks/ 2026-09-25 리뷰 수정 라운드의 요구사항과 작업 목록. 이 라운드가 쓰는 중이라 docs/ 밖에 그대로 둔다