ReddRadar
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/axiomantic/spellbook/tree/main/.claude/skills/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.
axiomantic/spellbook
spellbook-auditing
Meta-audit skill for spellbook development. Spawns parallel subagents to factcheck docs, optimize instructions, find token savings, and identify MCP candidates. Produces actionable report.
axiomantic/spellbook
project-encyclopedia
[DEPRECATED] Use project-level AGENTS.md files instead. Previously used for first-session codebase onboarding and persistent glossary creation.
axiomantic/spellbook
reviewing-impl-plans
Use when reviewing implementation plans before execution. Triggers: 'is this plan solid', 'review the plan', 'check before I start building', 'anything missing from this plan', 'will this plan work', 'audit the implementation plan'. NOT for: reviewing design documents (use reviewing-design-docs) or creating plans (use writing-plans).
axiomantic/spellbook
session-resume
Session resume protocol and session repairs handling. Loaded when spellbook_session_init returns resume_available: true, or when session_init returns a repairs array. Triggers: 'resume', 'continue', 'where were we', session resume, session repairs.
axiomantic/spellbook
brainstorming
Use when exploring design approaches, generating ideas, or making architectural decisions. Triggers: 'explore options', 'what are the tradeoffs', 'how should I approach', 'let's think through', 'sketch out an approach', 'I need ideas for', 'how would you structure', 'what are my options'. Also invoked by develop when design decisions are needed.
axiomantic/spellbook
debugging
Use when debugging bugs, test failures, or unexpected behavior. Triggers: 'why isn't this working', 'this doesn't work', 'X is broken', 'something's wrong', 'getting an error', 'exception in', 'stopped working', 'regression', 'crash', 'hang', 'flaky test', 'intermittent failure', or when user pastes a stack trace/error output. NOT for: test quality issues (use fixing-tests), adding new behavior (use develop).
Didn't find tool you were looking for?