document

Identify code changes and update CHANGELOG.md and user guides.

Updated Aug 27, 2026

Search Tags:#automation #git #documentation #CHANGELOG #documentation-sync #change-detection

Ready to run

npx skills add https://github.com/jforksy/claude-skills --skill document-jforksy

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document
Source: https://github.com/jforksy/claude-skills/tree/main/document
Command: npx skills add https://github.com/jforksy/claude-skills --skill document-jforksy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often lags behind code changes, causing confusion and wasted time as teams chase stale information.

Core Features & Use Cases

Change detection: Scans recent commits or diffs to identify what changed in code.
Documentation updates: Generates or updates relevant docs and changelogs to reflect changes.
Quality checks: Verifies alignment between code and docs, flags discrepancies for human review.
Use Case: After each merge, automatically refresh the CHANGELOG and API docs to match the new release.

Quick Start

Run the document skill to scan the latest commits and update the CHANGELOG and affected docs accordingly.

Frequently Asked Questions about document

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

FAQPage Schema

How do I automatically update documentation after a git commit?▼

To update documentation after a git commit, scan recent diffs to identify code changes and apply concise updates to referenced user guides and CHANGELOG.md files. This ensures docs stay current after each merge.

What is the best way to keep a CHANGELOG in sync with code changes?▼

Keeping a CHANGELOG in sync involves reading existing implementations, comparing them against current docs, and applying user-facing updates to reflect new code changes. This flags discrepancies for human review and ensures accurate records.

How does change detection work for multi-module repositories?▼

Change detection for multi-module repositories scans recent commits or PRs to identify modifications, compares them against existing documentation, and applies targeted updates to ensure all affected modules stay current.

Can I automatically refresh API docs after each merge?▼

Yes, you can refresh API docs after each merge by running an automated scan of the latest commits. It identifies what changed and generates or updates relevant documentation to match the new release.

Does this documentation sync approach work for user guides?▼

Yes, this approach works for user guides by comparing existing implementation against current documentation after each commit, applying concise user-facing updates to ensure guides reflect the latest code behavior.

Why does my documentation lag behind code changes?▼

Documentation lags behind code changes when updates are manual. Automating the detection of recent diffs and generating corresponding changelog entries prevents stale information and keeps docs aligned with the repository.