docs-update-all

Prompt file imported from Zynapses/Radiant (.windsurf/workflows/docs-update-all.md). Copyright stays with the author.

Master Documentation Policy (v4.2 — Expanded)

⚠️ THIS POLICY IS MANDATORY AND HAS NO EXCEPTIONS ⚠️

Every code change requires documentation updates. 21 documents total: 15 consolidated (merged 2026-02-10) + 6 standalone.

The Golden Rule

If you change code, you MUST update documentation. Period.

Do NOT:

• ❌ Say "I'll update docs later"
• ❌ Update only CHANGELOG.md
• ❌ Skip any applicable documentation
• ❌ Require the user to remind you

The 21 Documents (15 Consolidated + 6 Standalone)

App Documents (one per app)

System Documents

Standalone Documents (domain-specific deep dives)

Step 1: Identify Change Type

Before making ANY code change, identify what type of change it is:

Step 2: Look Up Required Docs

ALWAYS Update (Every Change)

✅ CHANGELOG.md

Think Tank Changes

✅ CHANGELOG.md — with platform annotation: [Web], [Mac], or [Both]
✅ docs/01-THINK-TANK.md (user guide, admin guide, tenant admin, Mac, Dojo — all in one doc)
✅ docs/15-STRATEGY-COMPETITIVE.md (if major feature)
⚠️  BIDIRECTIONAL: Web changes MUST mirror to Mac and vice versa
    See: /.windsurf/workflows/thinktank-dual-platform.md

Curator Changes

✅ CHANGELOG.md
✅ docs/02-CURATOR.md
✅ docs/15-STRATEGY-COMPETITIVE.md (if competitive advantage)

Dojo Changes

✅ CHANGELOG.md
✅ docs/01-THINK-TANK.md (Part XIII: Aurelius Dojo)

Platform / Admin Changes

✅ CHANGELOG.md
✅ docs/04-RADIANT-ADMIN.md (admin, deployment, health, spend governor)
✅ docs/15-STRATEGY-COMPETITIVE.md (if major)

Swift Deployer Changes

✅ CHANGELOG.md
✅ docs/05-SWIFT-DEPLOYER.md
✅ docs/19-STRATEGIC-SECURITY.md (if credential/security features)

Credential Lifecycle / Security Changes

✅ CHANGELOG.md
✅ docs/19-STRATEGIC-SECURITY.md (rotation, dormant keys, IAM audit, compliance)
✅ docs/13-SECURITY-AUTH-COMPLIANCE.md (auth middleware, access control)
✅ docs/05-SWIFT-DEPLOYER.md (if Swift Deployer security features)

Think Tank Mac App Changes

✅ CHANGELOG.md — with platform annotation: [Mac] or [Both]
✅ docs/01-THINK-TANK.md (Parts XI-XII: Mac Guide + Portability Manifest)
⚠️  BIDIRECTIONAL: Mac changes MUST mirror to Web and vice versa
    See: /.windsurf/workflows/thinktank-dual-platform.md

Architecture / CDK / Lambda Changes

✅ CHANGELOG.md
✅ docs/06-ARCHITECTURE-ENGINEERING.md

Database Changes

✅ CHANGELOG.md
✅ docs/06-ARCHITECTURE-ENGINEERING.md
✅ docs/16-IMPLEMENTATION-SPECS.md (Section 07: Database Schema)

AI Brain / Consciousness Changes

✅ CHANGELOG.md
✅ docs/07-AI-SYSTEMS.md (Brain sections)

CATO Safety Changes

✅ CHANGELOG.md
✅ docs/07-AI-SYSTEMS.md (CATO Safety section)

OMEGA / Genesis Changes

✅ CHANGELOG.md
✅ docs/09-OMEGA-GENESIS.md (PRIMARY — all OMEGA content here)
✅ docs/20-OMEGA-ENGINEERING.md (engineering, architecture, marketing, API reference)
✅ docs/24-CARTRIDGE-SPECIALIZATIONS.md (if cartridge/specialization changes)
✅ docs/06-ARCHITECTURE-ENGINEERING.md (if architectural)
⚠️  Policy: /.windsurf/workflows/omega-docs-policy.md

Cartridge / Specialization Changes

✅ CHANGELOG.md
✅ docs/24-CARTRIDGE-SPECIALIZATIONS.md (PRIMARY — all cartridge content here)
✅ docs/15-STRATEGY-COMPETITIVE.md (if competitive advantage)
✅ docs/04-RADIANT-ADMIN.md (if admin-facing cartridge changes)
✅ docs/17-GLOSSARY.md (if new cartridge terms)

TTS / Voice / Speech Changes

✅ CHANGELOG.md
✅ docs/21-TEXT-TO-SPEECH.md (PRIMARY — all TTS content here)
✅ docs/06-ARCHITECTURE-ENGINEERING.md (if architectural)
⚠️  Policy: /.windsurf/workflows/tts-package-policy.md

Orchestration / UEP Changes

✅ CHANGELOG.md
✅ docs/10-ORCHESTRATION-WORKFLOWS.md

Data / Storage Changes

✅ CHANGELOG.md
✅ docs/06-ARCHITECTURE-ENGINEERING.md (Data & Storage section)

API / Service Layer Changes

✅ CHANGELOG.md
✅ docs/12-API-REFERENCE.md
✅ docs/06-ARCHITECTURE-ENGINEERING.md (if architectural)

Security / Auth / Compliance Changes

✅ CHANGELOG.md
✅ docs/13-SECURITY-AUTH-COMPLIANCE.md
✅ docs/22-COMPLIANCE-STANDARDS-GUIDE.md (if regulatory standard impact)
✅ docs/04-RADIANT-ADMIN.md (if admin-configurable)

Compliance / Regulatory Standards Changes

✅ CHANGELOG.md
✅ docs/22-COMPLIANCE-STANDARDS-GUIDE.md (PRIMARY — SOC 2, GDPR, HIPAA, ISO 27701, ISO 42001, HDS, DPF, PCI DSS)
✅ docs/13-SECURITY-AUTH-COMPLIANCE.md (if auth/access control impact)
✅ docs/19-STRATEGIC-SECURITY.md (if credential/rotation impact)

Operations / Runbook Changes

✅ CHANGELOG.md
✅ docs/14-OPERATIONS-RUNBOOKS.md

Competitive Advantage Features

✅ CHANGELOG.md
✅ docs/15-STRATEGY-COMPETITIVE.md

New Dependencies

✅ CHANGELOG.md
✅ docs/18-UI-UX-LIBRARIES.md

New Terms / Subsystems / Acronyms

✅ CHANGELOG.md
✅ docs/17-GLOSSARY.md (MANDATORY)

Engineering Roadmap Changes

✅ CHANGELOG.md
✅ docs/23-ENGINEERING-ROADMAP.md

Patent / IP Strategy Changes

✅ CHANGELOG.md
✅ docs/25-PATENTS.md (PRIMARY — all patent/IP content here)
✅ docs/15-STRATEGY-COMPETITIVE.md (if competitive advantage)

Step 3: Update ALL Identified Docs

For each document identified in Step 2, add content in the appropriate Part/Section within the consolidated document.

CHANGELOG.md Format

## [X.X.X] - YYYY-MM-DD

### Added/Fixed/Changed

#### Feature Name

**Description of change**

- Bullet point details

**Files Modified**: `path/to/files`

Step 4: Update Version Numbers

When updating any of the 15 consolidated documents, update the version number in the document header.

Step 5: Verify Completeness

Before marking task complete, verify:

□ CHANGELOG.md updated
□ Relevant app doc updated (01–05) if app-facing change
□ Architecture doc (06) updated if architectural change
□ Relevant system doc updated (06–23) if system-level change
□ OMEGA engineering doc (20) updated if OMEGA architecture/training/API change
□ TTS doc (21) updated if TTS/voice/speech change
□ Compliance doc (22) updated if regulatory/certification/compliance change
□ Glossary (17) updated if new terms/acronyms
□ Strategy (15) updated if competitive advantage
□ Version numbers updated in all touched docs
□ If Think Tank change: Mac sections in 01 updated (Parts XI-XII)
□ If Think Tank change: Dual-platform sync verified per thinktank-dual-platform.md

Step 6: Reassemble Complete Documentation

After updating ANY documentation files, regenerate the complete assembled documentation:

python3 tools/scripts/assemble-complete-documentation.py

This produces:

• docs/publications/RADIANT-THINKTANK-COMPLETE-DOCUMENTATION.md
• docs/publications/RADIANT-THINKTANK-COMPLETE-DOCUMENTATION.pdf

See policy: /.windsurf/workflows/docs-assemble-complete.md

Quick Reference Card

┌──────────────────────────────────────────────────────────┐
│           DOCUMENTATION UPDATE CHECKLIST (v4.2)          │
├──────────────────────────────────────────────────────────┤
│                                                          │
│  EVERY CHANGE:     ✅ CHANGELOG.md                       │
│                                                          │
│  THINK TANK+DOJO:  ✅ docs/01-THINK-TANK.md              │
│  CURATOR:          ✅ docs/02-CURATOR.md                  │
│  RADIANT ADMIN:    ✅ docs/04-RADIANT-ADMIN.md            │
│  SWIFT DEPLOYER:   ✅ docs/05-SWIFT-DEPLOYER.md           │
│                                                          │
│  ARCHITECTURE+DATA:✅ docs/06-ARCHITECTURE-ENGINEERING.md  │
│  AI+CATO SAFETY:   ✅ docs/07-AI-SYSTEMS.md               │
│  OMEGA/GENESIS:    ✅ docs/09-OMEGA-GENESIS.md             │
│  OMEGA ENGINEERING:✅ docs/20-OMEGA-ENGINEERING.md           │
│  TTS/SPEECH:       ✅ docs/21-TEXT-TO-SPEECH.md              │
│  ORCHESTRATION:    ✅ docs/10-ORCHESTRATION-WORKFLOWS.md   │
│  API REFERENCE:    ✅ docs/12-API-REFERENCE.md             │
│  SECURITY/AUTH:    ✅ docs/13-SECURITY-AUTH-COMPLIANCE.md   │
│  OPERATIONS:       ✅ docs/14-OPERATIONS-RUNBOOKS.md       │
│  STRATEGY:         ✅ docs/15-STRATEGY-COMPETITIVE.md      │
│  IMPL SPECS:       ✅ docs/16-IMPLEMENTATION-SPECS.md      │
│  GLOSSARY:         ✅ docs/17-GLOSSARY.md                  │
│  UI/UX:            ✅ docs/18-UI-UX-LIBRARIES.md           │
│  STRAT SECURITY:   ✅ docs/19-STRATEGIC-SECURITY.md        │
│  COMPLIANCE:       ✅ docs/22-COMPLIANCE-STANDARDS-GUIDE.md │
│  ENG ROADMAP:      ✅ docs/23-ENGINEERING-ROADMAP.md         │
│  CARTRIDGES:       ✅ docs/24-CARTRIDGE-SPECIALIZATIONS.md   │
│  PATENTS/IP:       ✅ docs/25-PATENTS.md                    │
│                                                          │
│  THEN: python3 tools/scripts/                            │
│        assemble-complete-documentation.py                │
│                                                          │
└──────────────────────────────────────────────────────────┘

Anti-Patterns (NEVER DO)

❌ "Documentation will be updated in a follow-up" ❌ "See code for details" ❌ Only updating one document when multiple apply ❌ Updating docs without updating version numbers ❌ Waiting for user to ask about documentation ❌ Introducing new terms/acronyms without updating 17-GLOSSARY.md

THIS POLICY IS MANDATORY. NO EXCEPTIONS. EVERY CODE CHANGE = DOCUMENTATION UPDATE.