doc-alignment

Audit markdown documentation against codebase implementation and generate risk-ranked mismatch reports.

Updated Mar 21, 2026
One-click install
npx skills add https://github.com/AlexCMarty/CUNYAutoLogin --skill doc-alignment
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-alignment
Source: https://github.com/AlexCMarty/CUNYAutoLogin/tree/main/.claude/skills/doc-alignment
Command: npx skills add https://github.com/AlexCMarty/CUNYAutoLogin --skill doc-alignment

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Stale or incorrect documentation creates friction for developers, contributors, and users, leading to wasted time, incorrect implementation, and avoidable support requests when docs no longer reflect the actual codebase.

Core Features & Use Cases

  • Automated Doc Discovery: Scans the repository for all relevant markdown documentation, including root-level READMEs, CONTRIBUTING files, and docs in standard directories like docs/ and .claude/.
  • Claim Validation: Extracts concrete, testable claims from documentation and verifies them against source code, build configs, and runtime manifests.
  • Risk-Ranked Reporting: Classifies mismatches by severity (high, medium, low) and provides actionable patch guidance for documentation updates.
  • Use Case: Before a public release, run this audit to ensure your README's setup steps, feature lists, and API references match the current codebase, so contributors do not follow outdated instructions.

Quick Start

Use the doc-alignment skill to audit all markdown documentation in the current repository and generate a prioritized mismatch report at the repo root.

Frequently Asked Questions about doc-alignment

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

FAQPage Schema
How do I check if my repository documentation matches the actual codebase?

To verify repository documentation matches the codebase, run an automated audit that extracts concrete claims from markdown files and validates them against source code and build configs to identify stale or incorrect documentation.

What is documentation drift and how do I detect stale docs in my repo?

Documentation drift occurs when markdown files no longer reflect the current codebase implementation. You detect stale docs by scanning README, CONTRIBUTING, and inline documentation to validate concrete claims about paths, APIs, workflows, and configuration against source code.

Can I audit markdown docs to find incorrect API references and setup steps before a release?

Yes, you can audit markdown docs before a release to find incorrect API references and setup steps by extracting testable claims from documentation and verifying them against source code and runtime manifests to ensure contributors do not follow outdated instructions.

What's the best way to generate a risk-ranked report for documentation mismatches?

The best way to generate a risk-ranked mismatch report is to audit markdown documentation against the codebase, classify mismatches by severity as high, medium, or low, and provide actionable patch guidance with evidence citations for documentation updates.

Does this documentation audit work with standard markdown files like README and CONTRIBUTING?

Yes, this documentation audit works with standard markdown files like README and CONTRIBUTING, automatically scanning the repository for root-level markdowns and docs in standard directories like docs/ and .claude/ to validate their claims against the source code.