Files
clean-architecture-frontend…/docs/manual
DongHyeonka c4d587052e fix(removal): 참조 기능을 지워도 문서 게이트가 통과하고 드릴이 그것을 본다
문제
README는 참조 기능을 지울 수 있다고 적는다. 그러나 매뉴얼·입구 문서
10개가 참조 기능과 그 드릴 전용 파일의 경로를 백틱으로 적고,
verify:documentation(FE-GATE-017)은 백틱 경로의 존재를 검사한다. 그래서
참조 기능을 지운 복사본에서 문서 게이트가 경로 24개로 실패한다. 제거
드릴(test:sample-removal)은 문서를 복사하지 않고 그 게이트와 lint·
check:i18n·check:design-system을 돌리지 않아 이 충돌을 보지 못했다.

고른 방법
- 리뷰 5.2절 (b): 참조 기능이 가진 경로는 백틱 없이 "예제(참조 기능)"으로
  적는다. 기능 공통 모양은 생성 경로 꼴(`src/features/<id>/domain`)로
  적는다. 규칙은 docs/manual/reference/patterns.md 첫머리에 적었다.
- 드릴은 REMOVAL_FIXTURE_DOCUMENT_TARGETS(README·CHANGELOG·docs)까지
  복사하고, 지운 뒤와 생성 기능을 더한 뒤 두 번 모두 lint,
  verify:documentation, check:i18n, check:design-system을 돈다
  (FOLLOW-UP 09-07). 문서 테스트 두 개도 fixture에서 다시 돈다.
- 버린 대안: 검사기가 참조 기능 경로를 "없어도 되는 경로"로 보기(5.2
  (c)). 매뉴얼이 없는 파일을 가리키는 상태를 허용한다. 참조 기능을 지울
  수 없게 하기(5.2 (d)). README 약속과 드릴의 존재 이유가 바뀐다.

위험·한계
- 템플릿 자신에서도 참조 기능 경로의 존재를 문서 검사가 더는 보지
  않는다. 참조 기능 파일 이름을 바꾸면 그 문장은 사람이 고쳐야 한다.
- 드릴 시간이 lint·문서 검사 두 번만큼 는다.
- 드릴 실제 실행 결과는 이 커밋 메시지에 적지 않았다(공유 잠금 대기).

검증
- 참조 기능·참조 context·SAMPLE_EXTRAS를 지운 복사본(scratchpad
  sim-sample-docs.sh)에서 수정 전 FAIL_UNVERIFIED(문서 10개), 수정 뒤
  PASS_SCOPED.
- 저장소에서 verify:documentation PASS_SCOPED,
  documentation-readiness 14건 통과, eslint 통과.

Refs: docs/reviews/2026-11-03-maturity-review/14-template-product-docs.md 14-04
2026-11-04 21:02:14 +09:00
..

개발 매뉴얼

이 폴더는 이 템플릿으로 만든 프로젝트에 새 기능 하나를 추가하는 절차를 적는다. 기능 하나는 화면(라우트와 페이지)과 그 화면이 쓰는 API 호출을 함께 뜻한다.

시작은 corepack pnpm create:feature <id>다. 이 명령이 모든 merge 게이트를 통과하는 가장 작은 기능을 만든다. 그 뒤 이 매뉴얼의 단계대로 뼈대를 실제 기능으로 바꾼다.

누가 읽는가

  • 이 템플릿을 복사한 제품 팀의 프론트엔드 개발자.
  • 기능을 만드는 AI 에이전트. 단계마다 "쓸 스킬"을 적었다.
    • 스킬: Claude Code가 부르는 작업 지침의 이름이다. 사람이 읽을 때는 건너뛰어도 된다.

전제: 루트 README.md의 "Start locally"대로 로컬에서 앱이 뜬다.

읽는 순서

README (이 문서)
  → 01 작업 순서 (처음부터 끝까지 한 번)
  → 02 결정표 (단계 중 "무엇을 고를지" 막힐 때)
  → 03 기능 폴더 밖 파일 (폴더 밖을 고쳐야 할 때)
  → reference/ (명령 인자, 전역 ID, 패턴, 오류 메시지를 찾아볼 때)
문서 내용
01-add-a-feature.md 0~11단계. 단계마다 정할 것, 판단 기준, 잡는 검사와 못 잡는 것, 쓸 스킬
02-decision-tables.md context 경계, 계약 출처, 재시도 의미, 결과 불명, 인증, 페이지 템플릿
03-outside-feature-folder.md 기능 폴더 밖 파일. 생성 명령이 하는 것과 사람이 하는 것
reference/create-feature.md create:feature의 인자, 만드는 파일, 거부 조건, 출력
reference/global-ids.md 전역 ID 종류, 생성 명령이 만드는 값, 유일성 검사
reference/patterns.md 기능 개발 패턴과 예제 위치. 예제가 없는 패턴은 "없음"
reference/errors.md 생성·조립·레지스트리 검사의 실패 메시지와 고칠 파일

자주 나오는 말

  • 기능(feature): src/features/<id>/ 폴더 하나. 그 기능의 테스트는 tests/features/<id>/에 둔다.
  • context: 같은 URL 앞부분 아래에 있는 기능 묶음이다. 선언은 src/contexts/<context>/context-module.ts다.
  • 라우트 루트: context가 가진 URL 앞부분이다. 선언 파일의 CONTEXT_ROUTE_PATH가 그 값이다.
  • 생성기: scripts/generate-product-feature-index.ts. 기능·context 선언을 읽어 src/.generated/를 만든다. 모든 빌드·검사 명령이 먼저 돌린다.
  • 조립: 부팅이나 테스트 시작 때 설치된 기능의 계약·라우트·문구를 하나로 합치는 일. 중복이 있으면 여기서 실패한다.
  • 게이트: CI가 돌리는 검사 묶음이다. ID는 FE-GATE-0NN 꼴이고 정의는 config/ci/gates.json에 있다.
  • 계약 패키지: 백엔드 API의 모양과 신원(버전·digest·소스 리비전)을 담은 @org-contracts/* 패키지.
  • digest: 패키지 내용의 해시다. 같은 버전 번호로 내용이 바뀌는 것을 막는다.

공통 원칙

판단 원칙은 design-docs repo의 conventions/feature-design-principles.md(기능 설계 공통 원칙)에 있다. 프론트·백엔드 템플릿이 함께 쓰는 원칙이다. 이 매뉴얼은 원칙을 복사하지 않고 "(원칙 5)"처럼 번호로 가리킨다.

이 폴더에 두는 것

  • 이 템플릿의 파일 이름, 명령, 게이트 ID로 쓴 절차와 판단 기준.
  • 실패 메시지와 고칠 파일. 메시지는 코드의 문자열을 그대로 옮긴다.

이 폴더에 두지 않는 것

  • 두 템플릿 공통 원칙. design-docs의 원칙 문서에 둔다.
  • 목록. route ID, 오류 code, 게이트 목록을 여기에 적지 않는다. 정본 위치만 적는다(원칙 8).
    • route ID: src/features/installed-feature-contracts.ts의 ROUTE_REGISTRY
    • 게이트: config/ci/gates.json
    • 백엔드 오류 code와 멱등성 응답: 백엔드 템플릿의 clean-architecture-backend-template/docs/web/http-contract.md
  • 다른 repo의 계약 표. 백엔드 멱등성 응답 표는 위 파일 §2가 정본이다. 위치만 적는다.
  • 작업 이력. docs/reviews/와 docs/superpowers/는 복사한 프로젝트가 지울 수 있다. 이 매뉴얼은 그 문서에 기대지 않는다.

지금 구조가 아닌 설명은 링크하지 않는다.

  • docs/architecture/frontend-ports-adapters-and-boundaries.md의 "7. 권장 목표 디렉터리 구조".
    • 목표안이다. 지금 기능 폴더 구조와 다르다.
    • 지금 구조는 docs/architecture/layers.md가 정본이다.
  • docs/architecture/starter-experience.md의 예전 "폴더 밖 수정" 4행 표와 "governance는 바뀌지 않는다" 문장(2026-11-01 리뷰 시점 판).
    • 그 판은 실제로 고쳐야 하는 파일을 다 적지 않았다.
    • 지금 판의 "Adding a feature" 절 표가 정본이다. 03 문서가 이 표를 링크한다.
  • 참조 기능 페이지의 경로 문자열과 route 입력 cast.
    • 지금은 고쳐졌다. 그래도 이 매뉴얼의 예시는 route ID와 buildRouteUrl로만 쓴다.

문서와 코드가 다를 때

코드가 맞다. 이 매뉴얼은 주장이고, 근거는 코드·설정·실행 결과다.

docs/README.md §1에서 이 폴더를 링크하면 verify:documentation(FE-GATE-017)이 이 폴더 문서에 적힌 경로·명령·게이트 ID가 있는지 검사한다. 폴더 링크는 그 폴더 바로 아래 .md만 검사한다. reference/도 검사하려면 따로 링크한다. 설명이 코드와 맞는지는 검사하지 않는다.

플랫폼 규칙(예산·실행·검증·텔레메트리)의 근거는 docs/architecture/의 scale-architecture.md에 있다. 이 매뉴얼은 scale-architecture.md §24처럼 절 번호로 가리킨다.