Agent skill

documentation-updates

Use after modifying library skills, library commands, or agents to ensure CHANGELOG, README, and docs are updated

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/documentation-updates

SKILL.md

Documentation Updates

Invariant Principles

  1. Library changes require documentation trail - Every modification to installed content must be traceable through CHANGELOG
  2. Counts must match reality - README totals reflect actual files, never stale
  3. Generated docs stay fresh - Run generator after any library content change
  4. Repo skills are invisible - Internal tooling never touches external docs

Required Updates Matrix

Change CHANGELOG README Docs Generator
Add library skill "Added" section count++, add table row, add link ref Run
Modify library skill "Changed" section Only if description changed Run
Remove library skill "Removed" section count--, remove row/link Run
Add/modify command Appropriate section Update if count/description affected Run

Verification Checklist

  • CHANGELOG.md has entry under ## [Unreleased]
  • README.md counts match ls skills/*/SKILL.md | wc -l and ls commands/*.md | wc -l
  • New items have table rows AND link references
  • python3 scripts/generate_docs.py executed
  • Pre-commit hooks committed generated files

CHANGELOG Entry Format

markdown
## [Unreleased]

### Added
- **skill-name skill** - one-line description
  - Notable feature bullet

### Changed
- **skill-name skill** - what changed and why

### Removed
- **skill-name skill** - removal rationale

README Link Reference Pattern

markdown
[skill-name]: https://axiomantic.github.io/spellbook/latest/skills/skill-name/

Expand your agent's capabilities with these related and highly-rated skills.

Didn't find tool you were looking for?

Be as detailed as possible for better results