docs-check

Analyze git diffs to identify required documentation updates after code changes.

4|Updated Dec 14, 2025
One-click install
npx skills add https://github.com/LukasStrickler/ai-dev-atelier --skill docs-check
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-check
Source: https://github.com/LukasStrickler/ai-dev-atelier/tree/main/content/skills/docs-check
Command: npx skills add https://github.com/LukasStrickler/ai-dev-atelier --skill docs-check

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill analyzes git diffs to surface documentation gaps and recommends files to review, keeping docs synchronized with code changes.

Core Features & Use Cases

  • Analyzes git diffs to surface required documentation updates after code changes.
  • Categorizes changes (API, database, components, configuration, authentication) and suggests relevant docs to review.
  • Integrates with repository standards and references the Documentation Guide to guide updates.

Quick Start

Run the documentation check with:

  • bash skills/docs-check/scripts/check-docs.sh
  • bash skills/docs-check/scripts/check-docs.sh --verbose

Frequently Asked Questions about docs-check

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

FAQPage Schema
How do I check if my documentation needs updates after code changes?

To identify required documentation updates after code changes, analyze your git diff to surface gaps across API, database, and component modifications, then review the suggested documentation files to ensure docs stay synchronized with the codebase.

What is the best way to keep docs aligned with code changes before committing?

The best way to keep documentation aligned before committing is to run a pre-commit check that scopes git diff changes across API, database, and configuration categories, then references your repository's Documentation Guide to recommend relevant files for review.

How does analyzing a git diff help identify required documentation updates?

Analyzing a git diff identifies required documentation updates by categorizing code changes across API, database, components, configuration, and authentication scopes, then suggesting relevant documentation files to review for alignment with repository standards.

Can I use a documentation check to scope changes across API and database modifications?

Yes, you can use a documentation check to scope changes across API and database modifications by analyzing your git diff to categorize code changes and suggest relevant documentation files to review for each affected scope.

Do I need a Documentation Guide in my repository to enforce documentation alignment?

Yes, you need a Documentation Guide in your repository to enforce documentation alignment, as the check references this guide and related docs to direct updates and ensure code changes stay synchronized with repository standards.

What's the best way to find documentation gaps after modifying configuration files?

The best way to find documentation gaps after modifying configuration files is to run a documentation check that analyzes your git diff, categorizes the configuration changes, and suggests relevant documentation files to review for necessary updates.