이 대화를 모르는 서브에이전트에게 AGENTS.md부터 읽혀 두 일(새 기능 만들기, diff 리뷰)의 절차를 쓰게 했다. 막힌 곳 16, 사실과 다른 곳 5가 나왔다. 고친 것: - new-feature: 생성·기준선 다시 쓰기를 desktop에서 하고 --apply-back으로 받는다. FE-GATE-020은 제품 기능을 지우지 않으므로 그 기능의 제거 드릴을 따로 돌린다(사실과 달랐다). 생성 명령이 만드는 첫 context는 중간이다. 새 기능은 FE-GATE-026도 돌린다. 매뉴얼 예시 이름이 오면 묻는다. 초기 JS 기록의 파일을 적는다. - gates·improve·AGENTS: FE-GATE-013 결정 대기 동안의 merge 판정 문구, PR·diff 리뷰도 merge 단계 전부를 돌린다, diff 리뷰의 base·head 규칙과 ID 체계와 둘 곳, 라운드 세는 법, "빠른 게이트 8개"를 "검사 8개 (package script)"로. - review-criteria: 발견 한 개의 칸(가이드 36.3절 줄임)과 통제 M0~M4· 증거 E0~E4의 뜻을 옮긴다. 가이드 없이 판정할 수 있다는 문장을 맞춘다. - README·CLAUDE·decisions·rules/docs·skills: 최근 리뷰 README의 실제 절 이름, 사고 순서 흔적의 여섯 칸과 design-docs 위치, 보고 칸과 말투의 정본, `docs/work/README.md`를 가리키게, 리뷰 README 조치 절 예외, 스킬의 새 명령 모양. 고치지 않은 것: 세션에 주입된 옛 CLAUDE.md(시험 세션이 이 브랜치 전에 시작했다). 검증: scripts/verify.sh docs rc=0, scripts/verify.sh hooks 통과.
16 lines
1.7 KiB
Markdown
16 lines
1.7 KiB
Markdown
---
|
|
paths:
|
|
- "**/*.md"
|
|
---
|
|
|
|
# 문서를 고칠 때
|
|
|
|
- 문서 위치·묶음·언어 규칙은 `docs/README.md`, 쓰는 절차는 `docs/work/docs-writing.md`다.
|
|
- 기록 문서(`docs/reviews/`, `docs/history/`, `docs/superpowers/`, 결정 기록)는 머리 블록만 고친다. 리뷰 영역 문서를 리뷰 뒤에 고치지 않는다. 예외는 그 라운드를 맡은 총괄이 리뷰 README에 「조치」 절(과 그 아래 diff 리뷰 절)을 더하는 것이다.
|
|
- 진입 문서(루트 `AGENTS.md`·`CLAUDE.md`, `docs/work/`, `.claude/` 아래 문서) 본문에는 지난 리뷰 ID·번호만 쓴 결정을 넣지 않는다. 내용과 날짜를 쓰고 ID는 `docs/work/evidence.md`로 옮긴다. 편집 훅이 `scripts/check-work-docs.py`의 실패 줄을 먼저 알려 준다.
|
|
- `docs/README.md` 1절이 링크한 문서(루트 `AGENTS.md`, `docs/work/` 포함)는 `verify:documentation`이 백틱 경로·명령 경로·마크다운 링크·package script·FE-GATE ID를 본다. 있는 것만 쓴다. 검사를 피하려고 백틱을 빼지 않는다. 기능 제거 드릴의 문서 사본은 `scripts/lib/removal-fixture.ts`의 목록만 복사하니, 그 목록 밖 루트 파일을 마크다운 링크로 가리키지 않는다.
|
|
- repo 밖 문서(design-docs 등)는 링크가 아니라 코드 표기로 쓴다.
|
|
- 숫자(예산, 기준선, 테스트 수)를 옮겨 적지 않는다. 정본을 가리킨다.
|
|
- 그 문서를 읽는 테스트를 `git grep -n '<파일 이름>' -- tests scripts`로 찾는다. 있으면 desktop에서 돌린다.
|
|
- 고친 뒤: 작업 매뉴얼이면 `scripts/verify.sh docs`(노트북), 1절 묶음이면 desktop `scripts/verify.sh script verify:documentation`.
|