documentation-writer

Installation
SKILL.md

Documentation Writer

Use this skill for all docs edits in src/routes/(docs)/docs/content/ and when updating docs navigation in src/routes/(docs)/docs.json.

Non-negotiable rules

  1. Be concise: remove repetition and background that does not help the user complete a task.
  2. Be actionable: prioritize “what to do” over theory.
  3. One source of truth: if another page already has details, link to it instead of duplicating.
  4. Preserve structure: keep valid frontmatter and heading anchor IDs.
  5. Keep examples copyable: minimal, tested-looking, and directly relevant.
  6. Search before writing: always check if the content already exists in some form before adding new sections or pages.
  7. Check Relevant Code: Search the codebase inside src/ for any relevant code, comments, or tests that can inform the documentation content and ensure accuracy.

Docs config model (current)

docs.json is versioned. Sidebar lives inside tabs:

  • versions[].content.navigation.tabs[].sidebar
Related skills
Installs
5
GitHub Stars
4.9K
First Seen
Mar 5, 2026