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.
安装与使用
请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。
查看来源 ↗使用指南技能说明
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:
- Filename patterns:
*SSOT*.md,*ARCHITECTURE*.md,DESIGN.md - Content markers: Tables of contents, "Source of Truth" headers
- 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
- File existence: Verify all referenced files exist
- Export validation: Confirm mentioned exports are present
- Path accuracy: Check internal paths are correct
- 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--docsto 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
使用示例
查看来源仓库中的使用示例与配置说明。
查看来源 ↗来源历史
- 收录时间
- 2026-01-20
- 索引更新时间
- 2026-01-30
- Branch
- main
收录与同步日期属于本站记录。源码修改历史请查看来源仓库。
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!