doc-check

Analyze code diffs to identify documentation gaps and propose updates.

98|10|Updated Feb 16, 2026
One-click install
npx skills add https://github.com/jiayaoqijia/eth2030 --skill doc-check-jiayaoqijia
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-check
Source: https://github.com/jiayaoqijia/eth2030/tree/main/.claude/skills/doc-check
Command: npx skills add https://github.com/jiayaoqijia/eth2030 --skill doc-check-jiayaoqijia

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Prevents missing or outdated documentation by automatically validating that code changes are accompanied by appropriate docs updates.

Core Features & Use Cases

  • Change-diff documentation review: Analyzes PR diffs to identify potential documentation gaps.
  • Documentation update suggestions: Proposes specific doc edits or additions to align with code changes.
  • PR workflow integration: Supports checks in CI or pre-merge steps to enforce documentation quality.

Quick Start

Review the latest code changes in your branch and generate a plan for necessary documentation updates.

Frequently Asked Questions about doc-check

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

FAQPage Schema
How do I identify documentation gaps in my PR before merging?

Identify documentation gaps by analyzing branch diffs and PR changes to validate that code modifications are accompanied by appropriate, accurate documentation updates before code ships.

What is the best way to automate documentation checks during code review?

Automate documentation checks by integrating change-diff analysis into CI or pre-merge workflow steps to enforce documentation quality, validating that code changes have corresponding doc updates.

How do I generate a documentation update plan for my software project?

Generate a documentation update plan by analyzing your latest branch diffs to detect missing information, producing a concrete doc-change plan with specific edit suggestions and validation checks.

Does this documentation review approach work without external dependencies?

Yes, this documentation review approach works without external dependencies, analyzing change-diffs directly across software projects to propose corresponding doc updates and validation checks.

When do I need to validate documentation accuracy in my development workflow?

Validate documentation accuracy during code reviews, PRs, and branch diffs across software projects to prevent missing or outdated documentation from being introduced into the codebase.