docs-update
Standard procedure for updating documentation
When & Why to Use This Skill
This Claude skill provides a standardized framework for managing technical documentation updates. It streamlines the workflow for maintaining README files, API documentation, and JSDoc comments, ensuring that both user-facing and developer-facing materials remain accurate, well-formatted, and synchronized with the latest code changes.
Use Cases
- Feature Releases: Automatically following a checklist to update 'features.md' and 'README.md' whenever new functionality is deployed to ensure users have immediate access to current instructions.
- API Reference Maintenance: Keeping developer documentation and JSDoc comments up-to-date with code changes to prevent integration errors caused by outdated API specifications.
- Documentation Audits: Performing systematic quality checks on existing documentation folders to verify link integrity, formatting consistency, and setup procedure accuracy.
| name | docs-update |
|---|---|
| description | Standard procedure for updating documentation |
Procedure
- Identify the scope of changes (User facing vs Dev facing).
- Update
README.mdif setup changed. - Update
docs/*.md(e.g.,features.md,api.md) as needed. - Add JSDoc comments to new functions.
- Verify links and formatting.