check-doc

Identify documentation drift by analyzing recent git diffs against project docs.

36|12|Updated Nov 7, 2018
One-click install
npx skills add https://github.com/covoiturage-gouv-fr/mono --skill check-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: check-doc
Source: https://github.com/covoiturage-gouv-fr/mono/tree/main/.claude/skills/check-doc
Command: npx skills add https://github.com/covoiturage-gouv-fr/mono --skill check-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drift between code and its guidance is common; this Skill helps ensure CLAUDE instructions and project docs stay synchronized after changes.

Core Features & Use Cases

  • Review recent changes using git diff HEAD~1 or files specified in $ARGUMENTS to identify documentation gaps.
  • Map changed files to relevant docs and propose updates in CLAUDE-*.md files, README, and API docs.
  • Maintain traceability with a lightweight checklist that teams can follow during reviews.

Quick Start

Run a documentation review on the latest changes to ensure CLAUDE instructions and project docs stay synchronized.

Frequently Asked Questions about check-doc

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

FAQPage Schema
How do I detect documentation drift after code changes using git diff?

To detect documentation drift, analyze recent git diffs to map changed files against existing guidance. This identifies gaps in CLAUDE instructions, READMEs, and API references, generating a clear report of inconsistencies to guide necessary doc updates.

What is the best way to keep project docs aligned with code changes automatically?

Keeping docs aligned with code changes involves reviewing recent commits and mapping modifications to relevant documentation. A lightweight checklist ensures traceability during reviews, proposing updates for CLAUDE files and API references to maintain consistency.

Can I check specific files for documentation gaps instead of the latest commit?

Yes, you can check specific files for documentation gaps by passing file paths as arguments. This optional scoping overrides the default HEAD~1 diff analysis, allowing targeted reviews of specific scopes rather than the entire recent code change set.

Does this documentation review tool support CLAUDE.md and API references?

Yes, documentation review supports CLAUDE-*.md files, READMEs, and API references. It analyzes recent changes to ensure these guidance documents remain synchronized with the actual codebase, preventing inconsistencies across project instructions and technical specs.

When should I use a documentation checklist for code reviews?

Use a documentation checklist for code reviews when you need to maintain traceability between code changes and project guidance. It helps teams systematically verify that CLAUDE instructions and API docs are updated, preventing documentation drift during active development.