skills.rest
voidful
voidfulCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

documentation-review

Review documentation for accuracy against source code and detect doc-code drift.

1|Updated Apr 8, 2026
Search Tags:#documentation#markdown#verification#quality#review#accuracy#doc-code drift
One-click install
npx skills add https://github.com/voidful/Aixlarity --skill documentation-review-voidful
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-review
Source: https://github.com/voidful/Aixlarity/tree/main/.aixlarity/skills/documentation-review
Command: npx skills add https://github.com/voidful/Aixlarity --skill documentation-review-voidful

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation that disagrees with the source code actively misleads readers. This Skill catches doc-code drift by systematically verifying that every claim, code reference, and example in your docs matches what actually exists in the repository. ## Core Features & Use Cases - Code Reference Verification: Checks that every file path, function name, and CLI command mentioned in docs actually exists in the repo. - Honest Feature Status: Flags docs claiming features that are unimplemented, partially wired, or just stubs, with CRITICAL/WARNING/INFO severity levels. - Runnable Example Validation: Verifies readers can copy-paste examples and get the described result, plus checks that numbers (tool counts, test counts) and links are current. - Use Case: Before a release, run a documentation review over README.md and docs chapters to catch stale install instructions, outdated stats, and broken cross-references before users hit them. ## Quick Start Review the documentation in this repository for accuracy against the source code and report any doc-code drift with severity levels.

Frequently Asked Questions about documentation-review

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

FAQPage Schema
How do I check if documentation matches source code?▼

Verify every code reference in the docs against the repository: file paths, function names, and CLI commands must exist. Then confirm feature claims are implemented, examples run as written, and numeric stats like tool or test counts are current.

What is doc-code drift and how do I detect it?▼

Doc-code drift happens when documentation falls out of sync with the code it describes. Detect it by auditing code references, feature status claims, runnable examples, counts, and links, then classifying findings by severity.

How should documentation review findings be prioritized?▼

Use three severity levels: CRITICAL when docs claim a feature the code does not implement, WARNING when an example would fail if a reader tried it, and INFO for minor wording, outdated screenshots, or style inconsistencies.

Which documentation areas drift most often?▼

Stats like tool and test counts drift fastest, followed by install instructions, clone URLs, feature lists, architecture diagrams, and comparison claims. Internal cross-references and external links also break frequently.

When is a documentation review not enough?▼

A review verifies accuracy against current code but does not fix the underlying drift process. Teams needing ongoing prevention should pair reviews with CI checks or doc tests that fail builds when examples break.

Related Skills

Explore More Software Engineering Skills→
macalbertmacalbert
138

doc-sync

Audits and synchronizes documentation across website, READMEs, and docs directories to detect drift.

Community
Intermediate
basmawebinfo-hubbasmawebinfo-hub

docs-guard

Verify technical documentation claims against source code evidence.

Community
Advanced
jeremybrasherjeremybrasher

maintain-verification-skill

Audits and corrects a project's verification skill and feature map against live application behavior.

Community
Advanced
manastalukdarmanastalukdar
1

docs-sync

Detect code changes and update related documentation files in git workflows.

Community
Intermediate