Commit Graph
4 Commits
Author SHA1 Message Date
DongHyeonka 21dd9dc96c docs(reviews): 공용 리뷰 가이드 두 파일을 design-docs 정본 포인터로 바꾼다
문제
리뷰 가이드와 실행 체크리스트는 백엔드·프론트 두 템플릿이 함께 쓰는
리뷰 기준인데 프론트 repo의 docs/reviews/ 안에 있었다. 소유자가
2026-11-06 design-docs로 옮기기로 정했고(위임 루프 설계 결정 D13),
정본이 design-docs main 5f35810에 들어갔다. 이 repo의 사본이 그대로
남으면 두 곳에 본문이 생겨 서로 갈라진다.

고른 방법
- 두 파일을 정본 위치만 적은 포인터로 바꿨다. 정본 경로는 design-docs
  저장소 기준(conventions/...)으로, 링크 없이 코드 표기로 적었다.
  다른 저장소라 상대 링크는 이 checkout에서 따라갈 수 없다.
- 포인터에 절 번호가 정본에서도 같다는 것과, 옮기기 전 마지막 판을
  읽는 git show 명령(가이드 003832b6, 체크리스트 752a61f2)을 적었다.
  정본과 이 repo 판의 차이는 맨 위 "옮긴 기록" 블록과 서로 가리키는
  링크뿐이라 절 번호는 바뀌지 않았다.
- 파일 이름과 위치는 그대로 뒀다. CLAUDE.md와 지난 리뷰 문서가 이
  경로를 가리키므로 링크가 끊기지 않는다.
- docs/README.md의 reviews/ 행을 "가이드는 design-docs로 옮겼고
  여기에는 포인터만 있다"로 고쳤다.
- 버린 대안: 두 파일 삭제. CLAUDE.md 링크와 지난 리뷰 문서의 가이드
  경로가 끊긴다. CLAUDE.md는 소유자 승인 대상이라 이 커밋에서 바꾸지
  않는다.

위험과 한계
- design-docs를 받지 않은 환경(다운스트림 복사본, CI)에서는 정본을
  열 수 없다. 이력이 있는 checkout은 git show 명령으로 옛 판을 읽는다.
- CLAUDE.md는 여전히 포인터 파일을 리뷰 기준으로 가리킨다. 링크를
  design-docs로 바꿀지는 소유자가 정한다.
- verify:documentation은 docs/README.md 1절에서 링크한 문서만 보므로
  포인터 두 파일 안의 경로는 검사하지 않는다.

검증
- desktop에서 corepack pnpm verify:documentation, corepack pnpm
  test:unit 통과. 로그는 desktop ~/d13-review-guide-pointer-logs/.
- 기준 브랜치: PR #8 끝 fix/maturity-review-2026-11-06(1141969f).
2026-11-07 11:18:42 +09:00
DongHyeonka 003832b694 docs(changelog): 리뷰 발견 ID에 라운드를 붙인다 (1101/14-02)
문제
리뷰 라운드마다 발견 ID를 `NN-MM`으로 새로 매긴다. CHANGELOG의
`(14-02)`는 0925 라운드의 "CI 계약 고정"인데, 0929 라운드의 14-02는
"README 업데이트 절차"이고 이번 라운드에도 14-02가 있다. CHANGELOG는
복사한 프로젝트가 변경 근거를 찾는 유일한 링크라 ID가 어느 라운드인지
모르면 다른 결함을 읽게 된다. 리뷰 가이드에 ID 네임스페이스 규칙이 없다.

고른 방법
- CHANGELOG 0.2.0 절의 ID 98개에 `0925/`를 붙였다(`F-N`은 0925
  FOLLOW-UP의 ID라 같이 붙였다). 기계적 치환이다: 괄호 안의
  `NN-MM`·`F-N`만, 범위(`01-01~01-11`)는 앞에만, 날짜는 건드리지 않는다.
  0.1.0 절의 `R-x.y`는 다른 체계라 그대로 둔다.
- CHANGELOG 머리말에 `MMDD/NN-MM` 규칙과 F-N의 뜻을 적었다.
- 리뷰 가이드 36.3 "ID·제목"에 같은 규칙을 넣었다. 라운드 안에서는
  `NN-MM`, 밖에서 가리킬 때는 `MMDD/NN-MM`. 기존 코드 주석 약 339곳은
  고치지 않고 새로 쓰는 것부터 붙인다(리뷰의 최소 개선 방향 ③).
- tests/unit/changelog-review-ids.test.ts가 CHANGELOG 괄호 안의 라운드
  없는 ID를 막는다. 리뷰가 적은 grep 검증을 test:unit 게이트로 옮긴 것이다.

버린 대안
- CHANGELOG 표에 라운드 열 추가: "그 밖의 수정" 목록에는 표가 없어 규칙이
  둘이 된다. ID 자체에 붙이는 쪽이 코드 주석·커밋 제목과 같은 형식이다.
- 접두어를 `YYYYMMDD/`로: 이미 브랜치의 커밋과 리뷰 README가
  `0929/03-01` 형식을 쓴다. 해가 바뀌어 월일이 겹치면 그때 연도를 붙인다.

위험·한계
- 기존 주석과 0.2.0 커밋 제목은 라운드 없는 ID로 남는다(혼재 기간).
- 테스트는 괄호 안 쉼표 구분 토큰만 본다. 괄호 밖 본문에 쓴 ID는 잡지
  않는다.

검증
- RED: node scripts/run-vitest.ts run tests/unit/changelog-review-ids.test.ts
  실패 "expected [ '03-03', '03-01', '08-03', …(95) ] to deeply equal []"
- GREEN: 같은 테스트 통과. 리뷰의 검증 명령
  `grep -cE '\(([0-9]{2}-[0-9]{2})' CHANGELOG.md` → 0
- eslint, tsc(test), verify-documentation-readiness PASS_SCOPED,
  check-ci-contract PASS(새 테스트 파일이 test:unit 게이트에 들어감)

Refs: docs/reviews/2026-11-01-maturity-review/14-template-product-docs.md 14-02
2026-11-01 22:49:13 +09:00
DongHyeonka 752a61f28b refactor: 리펙토링 문서 추가 2026-10-02 14:25:27 +09:00
DongHyeonkaandClaude Opus 5.5 412b3d1f1e docs: add the maturity review guide and the 2026-09-25 full review
CLAUDE.md makes the guide the standing review standard for this repo.
The review folder holds 14 area reports and the summary with the
28-perspective table and the finding index.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 21:05:08 +09:00