docs: 입구 문서가 새 기능 추가 매뉴얼을 가리킨다 (1101/16-01)

문제: docs/manual/을 더했지만 입구 문서(README.md, docs/README.md)가
링크하지 않아 찾을 수 없고, verify:documentation도 매뉴얼을 검사하지
않았다.

방법: docs/README.md 1절의 세부 규칙 목록에 manual/과 manual/reference/를
링크한다. 1절에서 링크한 문서는 verify:documentation(FE-GATE-017)이 경로·
script·게이트 ID 실재를 검사한다. 루트 README의 Documentation 절에는
create:feature에서 시작하는 안내 한 줄을 둔다.
버린 대안: 입구 문서 표에 매뉴얼을 더하기 — 표는 계약을 정하는 문서
목록이고 매뉴얼은 그 계약을 쓰는 절차라 세부 목록에 둔다.

검증: verify-documentation-readiness PASS_SCOPED. documentReferences에
매뉴얼 8개 파일이 모두 들어가고 빠진 경로·script·게이트 ID 0.
문서 관련 단위 테스트 3파일 17건 통과.
This commit is contained in:
DongHyeonka
2026-11-03 07:28:19 +09:00
parent 8b2048763b
commit e121a1a0e7
2 changed files with 3 additions and 0 deletions
+2
View File
@@ -212,6 +212,8 @@ and executable gates pass.
[`docs/README.md`](docs/README.md) sorts the documents into current contracts,
target designs and work history.
[`docs/manual/`](docs/manual/README.md) is the step-by-step guide (Korean) for
adding a feature, starting from `corepack pnpm create:feature <id>`.
### Files you can delete after copying
+1
View File
@@ -29,6 +29,7 @@ README와 입구 문서는 영어, recipe·ledger·스타일 문서는 한국어
입구 문서가 가리키는 세부 규칙:
- 새 기능 추가 매뉴얼(작업 순서, 단계별 판단 기준, `create:feature`): [`manual/`](manual/), [`manual/reference/`](manual/reference/). 한국어다
- 규모 설계(구조·소유·실행·트래픽·오류·검증·텔레메트리·릴리스 일관성)와 코드 주석 `scale-architecture.md §N`의 근거: [`architecture/scale-architecture.md`](architecture/scale-architecture.md). 절마다 현재 계약인지 기록만인지 머리말 표에 적었다
- 계약 소유와 호환성: [`architecture/contract-ownership.md`](architecture/contract-ownership.md), [`contracts/compatibility.md`](contracts/compatibility.md)
- 정적 배포와 런타임 설정: [`architecture/static-delivery.md`](architecture/static-delivery.md)