| name | docs-publishing |
| description | Produce and publish project-facing documentation artifacts (changelogs, walkthroughs, release docs). |
Docs Publishing
Use this skill when work includes release communication, external-facing walkthroughs, or documentation refresh after implementation.
Coverage
- changelog generation
- release documentation sync
- feature walkthrough/video documentation
- editorial quality pass for external-facing copy
Required Inputs
- change scope (PRs/commits/sprint tasks)
- intended audience (internal team, customers, OSS users)
- publication surface (
README, release notes, docs site, walkthrough)
- constraints (legal, security, rollout sequencing)
Workflow
- Gather source-of-truth deltas from git diff, sprint docs, and merged findings.
- Choose artifact set: changelog, rollout notes, migration notes, walkthrough updates.
- Draft concise content with explicit "what changed", "why", and "operator actions".
- For Rails projects, include touchpoints when relevant:
- migrations/backfills and rollback notes
- background job changes and idempotence expectations
- Turbo/Hotwire behavior changes and fallback behavior
- Validate every command/path against the repo before finalizing.
- Run editorial pass: accuracy, consistency, and no speculative claims.
- Publish/update docs and summarize any follow-up docs debt.
Context Discipline
- Start with changed files and active sprint context; do not preload unrelated guides.
- Pull extra references only for unresolved questions or high-risk release notes.
Output Contract
- Artifact list with updated paths.
- Summary of key user/operator impact.
- Explicit follow-ups for deferred documentation work.