update-docs

Update project documentation to reflect recent code changes.

9|Updated Aug 20, 2018
One-click install
npx skills add https://github.com/berlysia/dotfiles --skill update-docs-berlysia
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/berlysia/dotfiles/tree/main/.skills/update-docs
Command: npx skills add https://github.com/berlysia/dotfiles --skill update-docs-berlysia

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically update project documentation to reflect code changes, reducing drift and keeping READMEs, docs, and CLAUDE guides synchronized.

Core Features & Use Cases

  • Delegates documentation updates to a capable subagent to minimize manual toil.
  • Scans recent commits/PRs, identifies affected docs (README, docs/, CLAUDE.md), and suggests or applies updates.
  • Enforces quality criteria: accuracy, findability, consistency, and maintainability across docs.

Quick Start

Tell the agent to update the project documentation to reflect the most recent code changes.

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 project documentation to reflect recent code changes?

To update project documentation automatically, this Skill delegates the task to a subagent that scans recent commits and PRs to suggest or apply updates to READMEs, changelogs, and docs. It minimizes manual toil by identifying documentation drift and proposing synchronized changes.

What is documentation drift and how do I keep my README synchronized with code?

Documentation drift occurs when project docs fall behind recent code changes. To keep your README synchronized, this Skill scans commits to identify affected documentation files and applies updates that enforce accuracy, findability, consistency, and maintainability across your codebase.

How do I maintain documentation quality and consistency across a codebase?

To maintain documentation quality and consistency, this Skill enforces specific criteria including accuracy, findability, consistency, and maintainability. It executes updates via a subagent to ensure your docs, changelogs, and CLAUDE guides remain reliable and aligned with code changes.

Can I update CLAUDE guides and changelogs automatically based on commits?

Yes, you can update CLAUDE guides and changelogs automatically. This Skill targets codebases with these specific files, scanning recent commits and PRs to propose or apply updates that keep your documentation aligned with your latest code modifications.

Does this documentation update tool work without external dependencies?

Yes, this documentation update tool works without external dependencies. It operates by delegating the update process to a subagent within your existing environment, requiring no additional setup to scan commits and propose documentation changes.

What is the best way to reduce manual toil when maintaining project docs?

The best way to reduce manual toil when maintaining project docs is to delegate updates to a subagent. This Skill scans recent code changes to automatically identify affected documentation and propose updates, ensuring accuracy and maintainability without manual intervention.