Agent skill
documentation-updates
Use after modifying library skills, library commands, or agents to ensure CHANGELOG, README, and docs are updated
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
- Library changes require documentation trail - Every modification to installed content must be traceable through CHANGELOG
- Counts must match reality - README totals reflect actual files, never stale
- Generated docs stay fresh - Run generator after any library content change
- 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 -landls commands/*.md | wc -l - New items have table rows AND link references
-
python3 scripts/generate_docs.pyexecuted - Pre-commit hooks committed generated files
CHANGELOG Entry Format
## [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
[skill-name]: https://axiomantic.github.io/spellbook/latest/skills/skill-name/
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?