Is this skill language-specific?

No, it is language-agnostic and includes predefined check patterns for Node.js, Python, Rust, and Go environments.

Can I use this to block pull requests?

Yes, the skill generates a structured JSON result with a 'passed' status and priority levels (high, medium, low) that can be used as a gate in automated workflows to prevent merging undocumented changes.

Which documentation formats does it support?

It supports standard Markdown files (README.md, CHANGELOG.md), OpenAPI/Swagger specs, and common documentation folders across various programming languages.

How does Docs Check identify what needs documentation?

It analyzes git diffs to categorize changes into specific types like API endpoints, config schema changes, or breaking changes, then checks if relevant documentation files have been modified accordingly.

Docs Check Checkpoint

Name: Docs Check Checkpoint
Author: GGPrompts

byGGPrompts

•

内容管理

Automates documentation audits by analyzing code changes to identify required updates for READMEs, API specs, and changelogs.

Docs Check is a specialized conductor gate for Claude Code designed to ensure project documentation never falls behind development. By scanning git diffs, the skill intelligently categorizes changes—such as new API endpoints, configuration shifts, or breaking changes—and verifies if corresponding documentation files have been updated. It provides structured feedback with prioritized suggestions, helping teams maintain high-quality documentation standards and preventing the merge of undocumented features or breaking changes. This skill is essential for maintaining project health in fast-moving development environments where documentation often becomes an afterthought.

主要功能

011 GitHub stars

02Cross-references code modifications with README.md, CHANGELOG.md, and API docs

03Generates structured JSON checkpoint results with prioritized pass/fail status

04Intelligent categorization of changes into API, CLI, Config, or Breaking types

05Automated git diff analysis for uncommitted or branch-level changes

06Identifies missing migration guides for critical breaking changes

使用场景

01Automating CHANGELOG maintenance by identifying user-visible feature changes

02Enforcing documentation standards during the code review or pre-merge process

03Ensuring new API endpoints are documented in Swagger/OpenAPI specs before release

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add ggprompts/my-plugins docs-check

For use in Claude.ai and ChatGPT

Download Skill