update-docs

Analyze commit ranges or working tree changes to update documentation files.

39|5|Updated Dec 28, 2025
One-click install
npx skills add https://github.com/benjaminshoemaker/ai_coding_project_base --skill update-docs-benjaminshoemaker
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/benjaminshoemaker/ai_coding_project_base/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/benjaminshoemaker/ai_coding_project_base --skill update-docs-benjaminshoemaker

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures project documentation stays aligned with code changes by automatically updating README, AGENTS.md, CHANGELOG, and docs/ after commits or when analyzing the working tree.

Core Features & Use Cases

  • Automatic routing of changes from commits and the working tree to the appropriate docs files
  • Enforcement of the "README as landing page" pattern with links to detailed docs
  • Support for post-commit automation and manual modes (HEAD..HEAD, --working-tree, --audit)

Quick Start

  • Trigger automatically after commits via the post-commit hook
  • Manual usage: /update-docs HEAD~3..HEAD
  • Manual usage: /update-docs --working-tree
  • Audit: /update-docs --audit

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I automatically update documentation to sync with code changes?

You can automatically sync documentation with code changes by analyzing commit ranges or the working tree to route updates to README, AGENTS.md, CHANGELOG, and docs/ files. This Skill supports post-commit hook automation to keep project docs aligned.

How do I keep my README and CHANGELOG updated after a git commit?

To keep your README and CHANGELOG updated after a git commit, trigger the post-commit hook for automatic routing or manually run /update-docs HEAD~3..HEAD to analyze recent commits and apply changes to the appropriate documentation files.

Can I update docs from uncommitted working tree changes instead of commit history?

Yes, you can update docs from uncommitted changes by using the manual working tree mode. Running /update-docs --working-tree analyzes your current uncommitted modifications and routes the necessary updates to your project documentation.

What is the README-as-landing-page pattern for project documentation?

The README-as-landing-page pattern enforces keeping your README file as a high-level entry point with links to detailed docs. This Skill automatically routes granular updates to the docs/ directory while maintaining this structural pattern.

How do I audit my project documentation for missing updates?

You can audit project documentation for missing updates by running /update-docs --audit. This mode reviews your current codebase and documentation state to identify where docs are out of sync with recent changes.

Does this documentation sync tool require any external dependencies?

No, this documentation sync tool does not require any external dependencies. It operates independently to analyze git commit ranges and working tree changes to route updates across your README, AGENTS.md, CHANGELOG, and docs/ files.