문제: 하네스 PR #13이 더한 작업 매뉴얼·규칙은 이 브랜치가 바꾼 문서 체계의 옛 모습을 적는다. - 옛 경로: `docs/architecture/decisions/`, `docs/superpowers/`, 루트 `SPEC.md`, 목표 설계였던 `docs/testing/frontend-platform-testing-strategy.md` - 옛 검사 범위: 「docs/README.md 1절이 링크한 문서, 폴더 링크는 바로 아래 .md만」. 지금 verify:documentation은 살아 있는 문서 전부를 보고 언어· 문체·숫자·머리 블록도 본다 - 옛 docs/README.md 절(1절 묶음 / 2절 목표 설계 / 3절 작업 이력)과 README 절 이름(「Support scope」, 「Updating a copied project」) - #13의 template-contract-documents 시험은 README 지워도 되는 표를 `docs/superpowers/` 행으로 찾는데, 그 행은 이제 없다 고른 방법: 그 줄만 새 위치·새 절 이름·새 범위로 고친다(.claude/rules/docs.md, docs/work의 docs-writing·operate·research-design·reference 다섯, docs/problem-statement.md). 시험은 `docs/history/` 행으로 표를 찾는다. docs/work/evidence.md는 백엔드처럼 매뉴얼 규칙의 근거 기록이라 고치지 않고 `HISTORY_HOLDERS`에 넣어 참조·숫자 검사에서 뺀다. 위험: 하네스 문서의 다른 문장은 건드리지 않았다. 하네스 세션이 쓴 뜻을 바꾸지 않으려는 것이다. 검증: 문서 검사 여섯이 0건, `git grep -n -E 'docs/superpowers|architecture/decisions'`가 기록·CHANGELOG·출처 표시 밖에서 0건.
1.8 KiB
1.8 KiB
paths
| paths | |
|---|---|
|
문서를 고칠 때
- 문서 위치·수명·언어 규칙은
docs/README.md, 쓰는 절차는docs/work/docs-writing.md다. 살아 있는 문서는 본문까지 한국어로, 「~한다」체로 쓴다. - 기록 문서(
docs/reviews/,docs/history/,docs/design/, 결정 기록docs/adr/)는 머리 블록만 고친다. 리뷰 영역 문서를 리뷰 뒤에 고치지 않는다. 예외는 그 라운드를 맡은 총괄이 리뷰 README에 「조치」 절(과 그 아래 diff 리뷰 절)을 더하는 것이다. - 진입 문서(루트
AGENTS.md·CLAUDE.md,docs/work/,.claude/아래 문서) 본문에는 지난 리뷰 ID·번호만 쓴 결정을 넣지 않는다. 내용과 날짜를 쓰고 ID는docs/work/evidence.md로 옮긴다. 편집 훅이scripts/check-work-docs.py의 실패 줄을 먼저 알려 준다. - 살아 있는 문서 전부(루트
AGENTS.md,docs/work/,.claude/아래 문서 포함)를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(노트북), 그리고 살아 있는 문서를 바꿨으면 desktopscripts/verify.sh script verify:documentation.