grey-haven-documentation-alignment
6-phase verification system ensuring code matches documentation with automated alignment scoring (signature, type, behavior, error, example checks). Reduces onboarding friction 40%. Use when verifying code-docs alignment, onboarding developers, after code changes, pre-release documentation checks, or when user mentions 'docs out of sync', 'documentation verification', 'code-docs alignment', 'docs accuracy', 'documentation drift', or 'verify documentation'.
When & Why to Use This Skill
The Grey Haven Documentation Alignment skill is a sophisticated 6-phase verification system designed to eliminate documentation drift by ensuring technical docs perfectly match source code. It utilizes automated alignment scoring across function signatures, data types, and system behaviors to maintain high technical accuracy and reduce developer onboarding friction by up to 40%.
Use Cases
- Developer Onboarding: Streamline the integration of new engineers by providing verified, accurate documentation that matches the current state of the codebase.
- Post-Refactor Validation: Automatically identify and flag documentation mismatches immediately after significant code changes or API updates to prevent outdated information.
- Pre-release Documentation Audits: Execute a rigorous 101-point verification checklist before software releases to ensure all public-facing guides and examples are technically correct.
- Continuous Documentation Maintenance: Use automated alignment scoring (Signature, Type, Behavior, Error, Example) to proactively detect and fix 'documentation drift' in large-scale projects.
| name | grey-haven-documentation-alignment |
|---|---|
| description | "6-phase verification system ensuring code matches documentation with automated alignment scoring (signature, type, behavior, error, example checks). Reduces onboarding friction 40%. Use when verifying code-docs alignment, onboarding developers, after code changes, pre-release documentation checks, or when user mentions 'docs out of sync', 'documentation verification', 'code-docs alignment', 'docs accuracy', 'documentation drift', or 'verify documentation'." |
| # v2.0.43 | Skills to auto-load for docs verification |
| # v2.0.74 | Tools for documentation alignment verification |
Documentation Alignment Skill
6-phase verification ensuring code implementations match their documentation with automated alignment scoring.
Description
Systematic verification of code-documentation alignment through discovery, extraction, analysis, classification, fix generation, and validation.
What's Included
- Examples: Function signature mismatches, parameter changes, type updates
- Reference: 6-phase process, alignment scoring formula
- Templates: Alignment report structures
- Checklists: 101-point verification checklist
Alignment Scoring
Score = (Signature×30% + Type×25% + Behavior×20% + Error×15% + Example×10%)
- 95-100: Perfect
- 80-94: Good
- 60-79: Poor
- 0-59: Failing
Use When
- Onboarding new developers (reduces friction 40%)
- After code changes
- Pre-release documentation verification
Related Agents
documentation-alignment-verifier
Skill Version: 1.0