Commit Graph
2 Commits
Author SHA1 Message Date
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
DongHyeonka 0a7fbedca9 docs(architecture): 규모 설계서를 현재 계약 문서로 옮긴다 (1101/14-01)
문제: src/platform·src/apps·src/contexts의 구조·소유·예산·실행·
텔레메트리 규칙과 코드 주석 "Spec §N"의 근거가 2026-09-23 설계서
하나에만 있다. 그 설계서는 docs/reviews/ 안의 계획 묶음에 들어 있어
README가 복사 뒤 지워도 된다고 한 범위 안이다. 현재 계약 목록
(docs/README.md §1)에는 src/platform을 다루는 문서가 없다.

고른 방법: 설계서를 docs/architecture/scale-architecture.md로 복사한다
(git mv가 아니라 복사라 이력 묶음은 그대로 남는다). 본문 §1~§55는
영어 원문 그대로 두고 절 번호를 바꾸지 않는다. 맨 위에 상태 머리말을
붙인다: 현재 계약인 범위, 출처(커밋 6f6c48e와 원래 경로, git show로
보는 법), 코드와 달라진 곳을 절 끝 "> 2026-11-03 현재:"로 적는 규칙.
절 상태 표는 현재 계약(코드 참조) 41, 현재 계약 10, 기록만 4
(§40·§51·§53·§54), 미확인 0이다. 코드와 다른 18개 절에 차이를 한두
줄로 적었다(예: §4 최상위 domain/ 없음, §11 TrafficBudget에 deadline
없음, §40 부팅 게이트 없음, §47 CI는 pr 단계만). docs/README.md §1의
세부 규칙 목록에 새 문서를 더한다.
버린 대안: 필요한 절만 새로 쓰기. 68곳 넘는 주석의 절 번호 대응표가
필요해지고 원문과 갈라진다. 이력을 지우지 말라고 정책을 바꾸기
(리뷰 5.1절 (c)). 동기화 비용과 문서 섞임이 그대로 남는다.

위험·한계: 절 대조는 각 절을 가리키는 모듈의 타입·머리 주석·테스트
이름을 읽는 수준이다. 동작을 실행해 확인하지 않았다. 원문의 "Status:
Design approved…"와 예정 경로 줄은 머리말로 바꿨다. 예정 경로가 없는
파일을 가리켜 verify:documentation의 경로 검사에 걸리기 때문이다.
이 커밋만으로는 코드 주석이 아직 이름 없는 "Spec §N"이다. 다음
커밋이 바꾼다.

검증:
- 본문 비교: 원문 §1 이후와 새 문서 §1 이후의 diff에서 지운 줄 0,
  "> 2026-11-03 현재" 메모 외에 더한 줄 0
- node scripts/verify-documentation-readiness.ts: PASS_SCOPED
  (처음 "src/domain"을 백틱으로 적어 FAIL, 문구를 고쳐 PASS)
- node scripts/run-vitest.ts run tests/unit/documentation-readiness.test.ts
  tests/unit/deletable-history-documents.test.ts: 15 passed
2026-11-03 07:17:49 +09:00