docs-release-maintenance
Docs Release Maintenance
Use this skill to keep developer documentation aligned with software release and maintenance lifecycles. It covers publishing readiness, ownership, automation, freshness, and responsible deprecation or deletion.
This skill is derived from Docs for Developers: An Engineer's Field Guide to Technical Writing, especially Chapter 7, "Publishing documentation," and Chapter 11, "Maintaining and deprecating documentation." It is expanded with paraphrased guidance from Christopher Gales and the Splunk Documentation Team's The Product Is Docs: Writing Technical Documentation in a Product Development Group, especially Chapter 10, "Maintaining Existing Content," Chapter 25, "Writing SaaS Documentation," and Chapter 2, "Agile." Do not copy book prose into user outputs. Source: https://link.springer.com/book/10.1007/978-1-4842-7217-6
Quick Start
- Load
guidelines.mdto choose the smallest useful reference set. - Identify the release, affected users, docs owners, source of truth, and publication path.
- Use
workflows/plan-doc-release-maintenance.mdfor release or maintenance planning. - Use
workflows/refresh-existing-docs.mdwhen stale content, patch buildup, or dependency updates require a focused refresh. - Align doc publication, review, testing, announcement, and deprecation with code changes.
- Prefer automation that removes known toil; do not automate an unclear process.
Default Output
When planning release or maintenance work, return: