check-docs

Compare documentation files against recent code changes to detect drift.

97|4|Updated Mar 25, 2026
One-click install
npx skills add https://github.com/go-to-k/cdkd --skill check-docs-go-to-k
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: check-docs
Source: https://github.com/go-to-k/cdkd/tree/main/.claude/skills/check-docs
Command: npx skills add https://github.com/go-to-k/cdkd --skill check-docs-go-to-k

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drift is prevented by systematically checking README.md, CLAUDE.md, and docs/ against recent code changes to ensure alignment and accuracy.

Core Features & Use Cases

  • Automated diff checks to detect mismatches between code and documentation.
  • Selective deep-review triggering to decide when docs require human review.
  • Commit-gate signaling to integrate with CLAUDE's gating workflow for release discipline.

Quick Start

Run the check-docs workflow after code changes to verify documentation stays current with the codebase.

Frequently Asked Questions about check-docs

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

FAQPage Schema
How do I prevent documentation drift after recent code changes?

To prevent documentation drift, you can automatically compare your README.md, CLAUDE.md, and docs/ files against recent code changes to detect mismatches and ensure alignment. This systematic check helps maintain accuracy without manual review.

How do I check if my README needs updating after modifying src files?

You can check if your README needs updating by running an automated diff check that compares your documentation files against recent code changes in your src/ directory. This identifies mismatches and recommends necessary fixes.

What is a commit-gate signal for documentation consistency?

A commit-gate signal for documentation consistency is an automated check that prevents code commits from proceeding when documentation drift is detected. It integrates with your gating workflow to enforce release discipline by requiring docs updates.

When do I need a deep review of my project documentation?

You need a deep review of your project documentation when automated diff checks detect specific triggers or discrepancies between your docs and code. This selective triggering decides exactly when human intervention is required for accuracy.

Can I use a documentation diff checker with my existing CLAUDE.md file?

Yes, you can use a documentation diff checker with your existing CLAUDE.md file. The checker systematically reviews CLAUDE.md alongside README.md and docs/ to verify alignment with recent code changes and generate docs markers.

What are the limitations of automated documentation consistency checks?

Automated documentation consistency checks are limited to detecting defined triggers and mismatches between specified files like README.md, CLAUDE.md, and docs/ against code changes. They cannot replace human judgment for complex semantic documentation updates.