grey-haven-documentation-alignment

Validate code implementations against documentation across signatures, types, and examples.

29|4|Updated Aug 10, 2025

Ready to run

npx skills add https://github.com/greyhaven-ai/claude-code-config --skill grey-haven-documentation-alignment

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: grey-haven-documentation-alignment
Source: https://github.com/greyhaven-ai/claude-code-config/tree/main/grey-haven-plugins/core/skills/documentation-alignment
Command: npx skills add https://github.com/greyhaven-ai/claude-code-config --skill grey-haven-documentation-alignment

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and examples (resource) and templates (resource) components.

What problem does it solve?

This Skill eliminates the frustrating disconnect between code implementations and their documentation, preventing bugs and reducing onboarding time by 40%.

Core Features & Use Cases

6-Phase Verification: Systematic discovery, extraction, analysis, classification, fix generation, and validation.
Automated Alignment Scoring: Calculates precise alignment scores (95-100: Perfect, 0-59: Failing).
Use Case: When onboarding new developers, this Skill automatically verifies that all function signatures, types, behaviors, errors, and examples match between code and docs.

Quick Start

Verify documentation alignment for the user authentication module in the current project.

Frequently Asked Questions about grey-haven-documentation-alignment

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I verify that my code documentation matches the actual implementation?▼

Code-documentation alignment verification automatically compares function signatures, types, behaviors, errors, and examples between your implementation and docs to identify mismatches. This Skill validates across all three elements—references, examples, and templates—and scores alignment on a 0–100 scale, surfacing discrepancies like signature drift, missing parameters, or broken examples so you can fix them before release.

Can I use this to check documentation alignment during onboarding?▼

Yes. This Skill is designed for onboarding workflows to automatically verify that new developers see accurate, aligned documentation. It runs the six-phase workflow—discovery, extraction, analysis, classification, fix generation, and validation—on modules or components to confirm all function signatures and behaviors match docs, reducing onboarding time by up to 40%.

What languages and frameworks does code-documentation alignment support?▼

This Skill works across languages and frameworks by validating code implementations against their documentation at the signature, type, behavior, error, and example level. It applies to modules or components regardless of the underlying tech stack, making it suitable for polyglot projects and teams.

When should I run documentation alignment checks in my development workflow?▼

Run this Skill after code changes, before pre-release checks, during onboarding, or whenever you need to catch documentation drift. The six-phase workflow generates an alignment score and actionable fixes, making it easy to integrate into CI/CD pipelines or manual review gates to prevent signature drift and broken examples from reaching users.

What output do I get from a documentation alignment check?▼

The Skill outputs an alignment score (95–100: Perfect, 0–59: Failing), a detailed discrepancy report identifying which elements are misaligned, and actionable fixes you can apply to either code or documentation to restore alignment.

Does this work for large modules or only small components?▼

This Skill applies to modules or components of any size. It discovers, extracts, and analyzes code-docs pairs systematically, then classifies and generates fixes—scaling the validation workflow to match your project's scope.