When is the best time to use this skill?

It is most effective during developer onboarding, after significant code refactoring, or as a mandatory check during the pre-release documentation phase.

What types of documentation can it verify?

It is designed to verify API references, README files, inline comments, and technical guides that describe code behavior and signatures.

Can this skill automatically fix my documentation?

Yes, the skill includes a fix generation phase that can suggest or apply updates to synchronize your documentation with the current state of your code.

How does the documentation alignment scoring work?

The skill uses a weighted formula consisting of Signature (30%), Type (25%), Behavior (20%), Error handling (15%), and Example accuracy (10%) to provide a score from 0 to 100.

Documentation Alignment

Name: Documentation Alignment
Author: greyhaven-ai

bygreyhaven-ai

•

学習とドキュメンテーション

Ensures code implementations strictly match their documentation using a systematic 6-phase verification and scoring system.

概要

The Documentation Alignment skill provides a robust 6-phase verification framework designed to eliminate documentation drift and technical debt. By analyzing function signatures, types, behaviors, error handling, and code examples, it generates a weighted alignment score to pinpoint discrepancies. This skill is essential for maintaining high-quality technical docs, reducing developer onboarding friction by up to 40%, and ensuring that pre-release documentation accurately reflects the underlying codebase.

主な機能

101-point verification checklist for comprehensive documentation audits
Identification of parameter mismatches and outdated type definitions
Automated fix generation to synchronize documentation with recent code changes
6-phase verification system covering discovery, analysis, and validation
Automated alignment scoring based on signature, type, and behavior accuracy
15 GitHub stars

ユースケース

Performing pre-release audits to ensure API documentation is technically accurate
Detecting and fixing broken code examples in READMEs and external documentation
Streamlining developer onboarding by ensuring tutorials and guides match current code

概要

主な機能

101-point verification checklist for comprehensive documentation audits
Identification of parameter mismatches and outdated type definitions
Automated fix generation to synchronize documentation with recent code changes
6-phase verification system covering discovery, analysis, and validation
Automated alignment scoring based on signature, type, and behavior accuracy
15 GitHub stars

ユースケース

Performing pre-release audits to ensure API documentation is technically accurate
Detecting and fixing broken code examples in READMEs and external documentation
Streamlining developer onboarding by ensuring tutorials and guides match current code