Search

PythonReactSEOPDF
GitHub Skill

ssot-validation

Validates Single Source of Truth (SSOT) documentation files for parity with code. Use when user asks about SSOT validation, architecture docs, or project truth sources.

CaptainPhantasy☆ 1 Repository stars0 Repository forks

Installation

Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.

View source ↗Guides

Skill instructions

SSOT Validation

Validates Single Source of Truth (SSOT) documentation files to ensure they reflect actual code implementation.

What is SSOT?

SSOT files are the authoritative documentation for a project:

  • FLOYD-CLI_SSOT.md - Project structure, phases, implementation roadmap
  • CLAUDE.md - Agent rules and coding patterns
  • FLOYD_ARCHITECTURE.md - Architecture overview
  • DESIGN.md - Design decisions and patterns

When to Use

Trigger this skill when:

  • Validating SSOT files specifically
  • Checking if architecture docs match implementation
  • Verifying project structure documentation
  • After major refactoring

SSOT Detection Rules

Files are considered SSOT if they match:

  1. Filename patterns: *SSOT*.md, *ARCHITECTURE*.md, DESIGN.md
  2. Content markers: Tables of contents, "Source of Truth" headers
  3. Location: Root-level CLAUDE.md, docs/ directory

Validation Priorities

Priority File What to Check
1 docs/SSOT.md Project structure, file references
2 CLAUDE.md Code patterns, commands, paths
3 docs/ARCHITECTURE.md Component relationships
4 README.md Installation, usage instructions

Common SSOT Drift Issues

Issue Example Fix
Orphaned file references docs mentions src/old/file.ts Remove or update reference
Missing new components New agent not in architecture doc Add to component list
Outdated paths References to packages/ not src/ Update to current structure
Changed patterns Doc says use X, code uses Y Align documentation

SSOT-Specific Checks

  1. File existence: Verify all referenced files exist
  2. Export validation: Confirm mentioned exports are present
  3. Path accuracy: Check internal paths are correct
  4. Structure alignment: Directory tree matches reality

FLOYD Project Context

For FLOYD specifically, key SSOT files are:

  • docs/Floyd-CLI_SSOT.md - Primary structure doc
  • CLAUDE.md - Agent behavior rules
  • docs/FLOYD_ARCHITECTURE.md - Architecture overview
  • docs/agents.md - Agent system docs

References

  • commands/check.md - Use --docs to target SSOT files
  • scripts/parity-check.sh - Validation implementation
  • .claude/doc-parity.local.md - User config file

Examples

Check SSOT files specifically:

/doc-parity:check --docs=docs/Floyd-CLI_SSOT.md --depth=medium

Validate all SSOT files:

/doc-parity:check --docs=docs/*SSOT*.md --docs=CLAUDE.md

Fix SSOT drift:

/doc-parity:fix --docs=docs/Floyd-CLI_SSOT.md

Examples

Read the usage examples in the source repository.

View source ↗

Source history

Indexed on
2026-01-20
Index updated
2026-01-30
Branch
main

Index and sync dates describe this directory. View the source repository for code history.

GitHub ↗

chat Comments (0)

chat_bubble_outline

No comments yet. Be the first to share your thoughts!