Skills
.Work. You
Rest

updating-documentation-for-changes

Community

Ensure docs stay current before commits.

Product & Management#git#documentation#checklist#commit#audit#cross-references
Authorthurstonsand
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Before committing staged changes, this skill ensures all related documentation is current by systematically sweeping across README.md, CLAUDE.md, CHANGELOG, API docs, and cross-referenced materials to avoid missed references.

Core Features & Use Cases

  • Systematic documentation sweep: checks core files (README.md, CLAUDE.md, DESIGN_DOC.md/ARCHITECTURE.md, CONTRIBUTING.md, API docs, CHANGELOG.md/HISTORY.md) for references to changed functionality.
  • Consistency validation across docs: identifies mismatches between high-level docs and staged changes, including package metadata and cross-references.
  • Guidance and results: outputs a clear report of outdated or missing references and suggests necessary updates for a clean commit.

Quick Start

Stage your changes and run this skill to verify documentation is up to date before committing.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: updating-documentation-for-changes
Download link: https://github.com/thurstonsand/ansiblonomicon/archive/main.zip#updating-documentation-for-changes

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.