문서 중복·드리프트를 구조적으로 방지하기 위해 SSOT 원칙을 문서 체계에 적용한다. 신규: - docs/README.md: 문서 라우팅/역할/읽기 순서/SSOT 정의 (상대경로 링크) - scripts/validate_docs_sync.py: 가변 수치 하드코딩 금지 + 누락 엔드포인트 검사 수정: - CLAUDE.md: 문서 진입점 추가, SmartScanner 세부 동작 → architecture.md 링크 - README.md: 문서 네비게이션 섹션 추가, 고정 수치/파일별 케이스 수 제거 - docs/commands.md: validate_docs_sync.py 명령 추가; 중복 엔드포인트 2행 제거 - docs/testing.md: 테스트 총량 고정값 → pytest --collect-only -q 동적 확인으로 전환 - docs/ouroboros/82_doc_restructure_plan.md: draft → active, 실행 현황으로 전환 - .gitea/PULL_REQUEST_TEMPLATE.md: Docs Sync 체크리스트 추가 - .gitea/workflows/ci.yml + .github/workflows/ci.yml: validate_docs_sync 단계 추가 검증: - python3 scripts/validate_docs_sync.py: PASS Closes #350
61 lines
1.5 KiB
Markdown
61 lines
1.5 KiB
Markdown
## Linked Issue
|
|
|
|
- Closes #N
|
|
|
|
## Scope
|
|
|
|
- REQ: `REQ-...`
|
|
- TASK: `TASK-...`
|
|
- TEST: `TEST-...`
|
|
|
|
## Docs Sync (SSOT)
|
|
|
|
- [ ] `docs/README.md` 라우팅/역할 영향 여부 확인
|
|
- [ ] SSOT 문서(architecture/commands/testing/ouroboros registry) 업데이트 또는 "변경 없음" 명시
|
|
- [ ] 요약 문서(`README.md`, `CLAUDE.md`)에 가변 수치 하드코딩 추가 없음
|
|
- SSOT 반영 위치(링크):
|
|
|
|
## Ticket Stage
|
|
|
|
- Current stage: `Implemented` / `Integrated` / `Observed` / `Accepted`
|
|
- Previous stage evidence link:
|
|
|
|
## Main -> Verifier Directive Contract
|
|
|
|
- Scope: 대상 요구사항/코드/로그 경로
|
|
- Method: 실행 커맨드 + 관측 포인트
|
|
- PASS criteria:
|
|
- FAIL criteria:
|
|
- NOT_OBSERVED criteria:
|
|
- Evidence format: PR 코멘트 `Coverage Matrix`
|
|
|
|
## Verifier Coverage Matrix (Required)
|
|
|
|
| Item | Evidence | Status (PASS/FAIL/NOT_OBSERVED) |
|
|
|---|---|---|
|
|
| REQ-... | 링크/로그 | PASS |
|
|
|
|
`NOT_OBSERVED`가 1개라도 있으면 승인/머지 금지.
|
|
|
|
## Gitea Preflight
|
|
|
|
- [ ] `docs/commands.md`와 `docs/workflow.md` 트러블슈팅 선확인
|
|
- [ ] `tea` 사용 (`gh` 미사용)
|
|
|
|
## Session Handover Gate
|
|
|
|
- [ ] `python3 scripts/session_handover_check.py --strict` 통과
|
|
- [ ] `workflow/session-handover.md` 최신 엔트리가 현재 브랜치/당일(UTC) 기준으로 갱신됨
|
|
- 최신 handover 엔트리 heading:
|
|
|
|
## Runtime Evidence
|
|
|
|
- 시스템 실제 구동 커맨드:
|
|
- 모니터링 로그 경로:
|
|
- 이상 징후/이슈 링크:
|
|
|
|
## Approval Gate
|
|
|
|
- [ ] Static Verifier approval comment linked
|
|
- [ ] Runtime Verifier approval comment linked
|