Files
clean-architecture-backend-…/docs/history/packages/websocket-superpowers-package/VALIDATION.md
T
DongHyeonka 74108497d4 docs(records): 기록과 ADR 맨 위에 한국어 머리 블록을 단다
문제: 설계서·계획서·납품 패키지·증거·학습 문서와 ADR이 기록이라는 표시
없이 지금 문서처럼 읽힌다. 상태 칸이 설계서 72개 중 40개, 계획서는
거의 없고, 있어도 Approved·확정·Accepted.처럼 값이 제각각이며 영어다.

고른 방법: docs/design, docs/history, docs/adr, docs/notification/adr의
.md 246개 맨 위에 같은 모양의 머리 블록을 단다. 칸은 상태·작성일·
요약(한국어 한 문장)·현재 정본, 대체됐으면 대체됨이다. 블록은 표시 줄
두 개로 감싸서 빼면 원문 바이트가 그대로 돌아온다(246개 모두 대조함).
- 종류는 폴더가 정하고 둘째 줄에 적는다(plans/evidence는 증거).
- 상태는 원래 상태 줄을 고정 어휘로 바꾼 값이다. 상태 줄이 없는
  설계서와 체크 상자가 다 표시되지 않은 계획서는 「확인 안 함」.
  capability-status.md 제거 표로 지운 것이 확인된 설계서 다섯은 「폐기」,
  2026-07-20 하네스 설계·계획과 production capability platform 설계는
  「대체됨」이다.
- 현재 정본은 구조 정리로 옮겨질 수 있는 src/messaging·src/grpc 대신
  docs/ 쪽 문서나 옮기지 않는 leaf README를 가리킨다.
docs/README.md에 「문서 수명과 언어」「기록 문서의 머리 블록」「문서와
코드를 같은 변경에서 고친다」를 더하고, 파생 서비스 안내에 머리 블록
충돌 가능성을 적었다.

버린 대안: H1 제목 아래에 블록을 두는 안은 보기에는 낫지만 빼는 규칙이
파일마다 달라져 원문 복원이 기계적이지 않다. 「종류」 칸을 따로 두는
안은 폴더와 같은 정보를 두 번 쓰게 한다.

위험·한계: 「확인 안 함」 설계서 38개, 계획서 51개는 지금 유효한지
아무도 판정하지 않았다. 요약은 제목·목표 줄을 보고 쓴 것이라 본문을
끝까지 읽지 않았다. 납품 패키지 셋의 MANIFEST.sha256는 이제 맞지 않는다
(납품 당시 바이트의 해시이고, 블록을 빼면 다시 맞는다). 리뷰 폴더에는
아직 머리 블록을 달지 않았다.

검증: 머리 블록을 뺀 내용과 HEAD 원본 246개 일치, check-work-docs.py
rc=0, --links docs·README.md·CLAUDE.md·AGENTS.md 깨진 링크 0.
2026-11-07 12:23:32 +09:00

2.1 KiB
Raw Blame History

기록 · 납품 패키지 본문은 쓴 때의 원문이다. 지금 동작은 「현재 정본」을 읽는다.

  • 상태: 보관
  • 작성일: 2026-08-28
  • 요약: WebSocket 설계 패키지 묶음을 받을 때 한 정적 검증 결과다.
  • 현재 정본: src/adapter/inbound/websocket/README.md

WebSocket Superpowers 문서 정적 검증 결과

  • 검증일: 2026-08-14
  • 검증 명령: python validate_websocket_docs.py
  • 검증 출력: checks=719 passed=719 failed=0
  • 결과: PASS

문서 규모

문서 행 Task Create 경로
설계서 2,810 - -
Stable 구현 계획 4,293 53 121
Advanced 확장 계획 1,817 22 48

검증 항목

  • Stable Task 1–53 번호 연속성
  • Advanced Task 1–22 번호 연속성
  • 모든 Task의 Files, Interfaces, Implementation requirements, Step 1–5, commit 명령
  • Stable·Advanced Create 경로 중복 및 충돌 부재
  • TODO, TBD, FIXME placeholder 부재
  • Markdown code fence 균형
  • Stable Raw Typed JSON·Evidence·Ticket·Queue·Runtime·Nginx·Browser 계약 포함
  • Advanced Resume·Cluster·STOMP·Broker Relay·Binary·Compression·HTTP/2·3 계약 포함
  • 요구사항 원본 Appendix 및 research file 보존
  • SHA-256 manifest와 ZIP CRC 검증 가능 구조

검증 범위의 한계

현재 검증은 설계서와 구현 계획서의 정적 구조·내부 계약·패키지 무결성 검증이다. 실제 Backend Skeleton 저장소가 제공되지 않았으므로 다음은 실행하지 않았다.

Gradle configuration·compile
Spring Boot ApplicationContext
Tomcat·Jetty·Reactor Netty WebSocket contract
Nginx TLS Upgrade path
Chromium·Firefox·WebKit browser matrix
Redis ticket·session index integration
JPA result ledger transaction
Messaging replay/fan-out
Commit 후 socket reset fault
Slow consumer·memory·latency performance
STOMP·RabbitMQ broker relay
HTTP/2·HTTP/3 compatibility
Git commit