skills.rest
bkelly-lab
bkelly-labOFFICIAL
Explore all skills by this author →
GitHub

check-docs

Analyze git diffs to detect documentation gaps in code changes.

50|17|Updated Sep 2, 2023
Search Tags:#automation#documentation#docs#pull-request#git-diff#code-changes
One-click install
npx skills add https://github.com/bkelly-lab/jkp-data --skill check-docs-bkelly-lab
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: check-docs
Source: https://github.com/bkelly-lab/jkp-data/tree/main/.claude/skills/check-docs
Command: npx skills add https://github.com/bkelly-lab/jkp-data --skill check-docs-bkelly-lab

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams verify that code changes are accompanied by appropriate documentation updates, preventing knowledge gaps and out-of-sync docs.

Core Features & Use Cases

  • Diff analysis: Scans git diffs to identify documentation-related changes and missing updates.
  • Guided validation: Flags when doc files (e.g., Markdown) were not updated in response to code changes.
  • Use Case: When a PR modifies API surfaces or behavior, this Skill verifies documentation aligns with changes and surfaces gaps for review.

Quick Start

Run a quick check to determine whether documentation updates are required.

Frequently Asked Questions about check-docs

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

FAQPage Schema
How do I check if a pull request has missing documentation updates?▼

To check for missing documentation updates in a pull request, you can analyze the git diff to detect code changes and flag when corresponding Markdown or API notes are not updated. This surfaces doc gaps for review.

What is documentation drift and how does git diff analysis detect it?▼

Documentation drift occurs when code changes are not accompanied by matching doc updates. Git diff analysis detects it by scanning pull requests for behavioral modifications and identifying whether relevant Markdown files or comments were also modified.

How do I verify code changes have proper docs before merging?▼

You verify code changes have proper docs by running a validation check on the commit or pull request. This scans the git diff to identify API surface modifications and outputs a structured summary of necessary documentation updates.

Can I use this to validate API notes across software projects?▼

Yes, you can validate API notes across software projects by applying this check to pull requests or commits. It specifically focuses on changes to docs, comments, and API notes to report gaps and maintain consistency.

Does this tool work with existing git workflows and pull requests?▼

Yes, it works with existing git workflows by analyzing git diffs directly from pull requests or commits. No special dependencies are required to integrate this documentation verification into your current software project review process.

Related Skills

Explore More Content & Communication Skills→
williabywilliaby
2

pr-prepare

Generate Markdown pull request descriptions from git status, log, and diffs.

Community
Basic
liujiayi3703liujiayi3703

babysit

Monitor pull request status and manage review threads via GitHub CLI.

Community
Intermediate
R2W1csR2W1cs
1

lint-and-validate

Lint and validate JavaScript and Python code for syntax and style issues.

Community
Intermediate
ascerra-fullsend-rehearsalascerra-fullsend-rehearsal

code-review

Analyze code changes for correctness, security, intent, style, and documentation compliance.

Official
Advanced