playbook-technical-writing-docs-overhaul

Installation
SKILL.md

Playbook: Overhaul a neglected docs site

Sorted page types, working pipelines, and freshness signals readers trust again.

Track: πŸ—ΊοΈ Technical Writing Β· Domain: Journey Playbooks Β· Level: journey Β· ~80 min

Who this is for: Technical Writers, Developer Advocates, Engineers Who Document, Content Leads

When to Use This Skill

Sorted page types, working pipelines, and freshness signals readers trust again. Use it whenever a matching task appears in conversation β€” the agent loads these instructions on demand.

Journey Steps

  1. Step 1 β€” Sort docs into types readers recognize: start with "Label every existing page: learning-journey, task-recipe, information-lookup, or theory"
  2. Step 2 β€” Run docs through the same pipeline as code: start with "Store docs beside code or in sibling repo with same review gates"
  3. Step 3 β€” Write changelogs users read: start with "Categorize: Added / Changed / Fixed / Breaking / Security only"
  4. How it fits together: Sort types before rewriting anything. Half the mess resolves itself once modes separate.
Installs
1
GitHub Stars
2
First Seen
Sep 26, 2026