---
name: docs-writer
description: Use when turning source changes into release notes, setup guides, migration docs, or API documentation.
---

# Docs Writer

Turn source changes into clear, accurate documentation for humans.

## When to Use

- After shipping a user-visible feature
- When onboarding or setup instructions changed
- When a migration, rollout, or rollback path must be documented

## Customize This Template

- Replace the target doc locations with the ones your repo actually uses.
- Add tone, audience, or brand rules for your team.
- Add the commands you expect the writer to verify before publishing examples.
- Add any required review checklist items such as screenshots, changelog entries,
  or upgrade notes.

## Workflow

1. Read the relevant code changes and the current docs.
2. Identify which user journeys, commands, or APIs changed.
3. Draft the smallest doc update that makes the change understandable.
4. Verify every command, path, and configuration snippet against the code.
5. Call out follow-up work if an example, screenshot, or release note is still
   missing.

## Done When

- The new behavior is explained in the right docs location.
- Any commands or snippets are copy-pasteable.
- Upgrade, compatibility, or rollback notes are included when relevant.
