Skip to main content
Version: Next

Version Onboarding Checklist

Copy to input/checklist-v{NEW}.md and fill in as you go.

Rules: (1) Docs and tests only — code issues are reported not fixed. (2) LLM orchestrators delegate to subagents. (3) QR each doc tier before starting the next.


PREP §1

  • Confluence exports (.docx) → input/
  • Code at new tag → code/
  • Note old baseline: v____

Phase 1: Detect §2

  • Convert exports, diff code, identify affected REQs
  • Write Change Manifest: input/change-manifest-v{NEW}.md
  • GATE: Human approves manifest

Phase 2: Update Docs §3

  • SRS — update + QR + fix + re-QR
  • SDS — update + QR + fix + re-QR
  • STD — update + QR + fix + re-QR
  • Code mappings (code_tags.json)
  • GATE: Human reviews all doc changes

Phase 3: Write Tests §4

  • Create Test Fix Log: input/test-fix-log-v{NEW}.md
  • API test waves (8-10 agents/wave, QR each wave)
  • Browser test waves (up to 8 agents/wave, QR each wave)
  • Version-tag scenarios where behavior differs
  • GATE: TFL reviewed — behavioral changes confirmed with human

Phase 4: Validate §5

  • Generate traceability + run full suite + map to TM
  • Fix gaps/failures → re-run until clean
  • Docs build: 0 broken links, 0 Mermaid errors

Phase 5: Freeze §6

  • Docusaurus version snapshot + git tag + CLAUDE.md update

Reference

§1 Prep

§2 Detect

§3 Docs

Rule: QR each tier before starting the next (SRS → SDS → STD → code mappings). Why this matters

TierGuideKey sections
SRSSRS Update GuideAdd · Modify · Deprecate
SDSSDS Update GuideWhen to update · File inventory · Diagrams
STDSTD Update GuideAdd TCs · TC format · Coverage targets
CodeCode Mapping GuideWhat to map · Validation

QR tools: 7-dimension checklist · QR agent template · Wave structure

§4 Tests

§5 Validate

§6 Freeze