Where does it store internal developer notes?

Internal-only changes that don't affect end-users are documented in CLAUDE.md or agent-specific documentation to keep the main README focused on users.

How does the skill determine what needs to be documented?

The skill performs a git diff to analyze recent changes, then applies a decision matrix to categorize the update as a new feature, CLI option, behavior change, or internal refactor.

Does it work with CLI help commands?

Absolutely. It can run your CLI tool with --help flags to verify that the documentation matches the actual program output and update help strings in the source code if necessary.

Can it handle localized documentation?

Yes, it specifically checks for consistency between primary documentation and localized versions, such as README.md and README.ja.md.

Documentation Auto-Update

Name: Documentation Auto-Update
Author: tettuan

bytettuan

0•

学习与文档

Maintains comprehensive project documentation by automatically updating READMEs, CLI help outputs, and specialized guides based on code changes.

The Documentation Auto-Update skill ensures your project's user-facing documentation never falls behind development. By analyzing git diffs and identifying change types—such as new CLI options, breaking API changes, or internal refactors—the skill intelligently determines the appropriate documentation scope. It handles everything from synchronizing multi-language READMEs to updating JSON schema descriptions and migration guides, keeping your documentation accurate, consistent, and useful for end users and developers alike.

主要功能

01Automated CLI help string and usage verification

02Smart change-impact analysis for documentation scoping

030 GitHub stars

04Cross-language documentation synchronization for READMEs

05Consistency checking between code and documentation

06Agent-specific documentation and schema updates

使用场景

01Updating README tables and help text immediately after adding new CLI flags

02Synchronizing Japanese and English documentation versions after feature changes

03Maintaining internal development guidelines in CLAUDE.md for team consistency

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tettuan/climpt update-docs

For use in Claude.ai and ChatGPT

Download Skill