ux-doc-pass

star 0

Review README and contributor-facing docs for first-run clarity, onboarding quality, and GitHub-read usability in diagram-tours. Use when editing README, onboarding docs, authoring docs, runtime docs, or other user-visible documentation.

h-4vok By h-4vok schedule Updated 3/19/2026

name: ux-doc-pass description: Review README and contributor-facing docs for first-run clarity, onboarding quality, and GitHub-read usability in diagram-tours. Use when editing README, onboarding docs, authoring docs, runtime docs, or other user-visible documentation.

UX Doc Pass

Read docs like a new user and a hurried contributor.

Review for

  • what the product is
  • the fastest path to first value
  • valid inputs and startup modes
  • how to preview or troubleshoot locally
  • whether examples are easy to copy
  • whether jargon appears before the reader has context

Prioritize these files

  • README.md
  • docs/adoption-onboarding.md
  • docs/authoring-guide.md
  • docs/runtime-loading.md
  • docs/testing/smoke-tests.md

Output

  • findings first, ordered by severity
  • call out confusion, missing prerequisites, hidden assumptions, and weak examples
  • suggest tighter wording when the problem is copy, not product behavior

Remember

UX here includes:

  • GitHub readability
  • first-run CLI comprehension
  • authoring discoverability
  • contributor confidence
Install via CLI
npx skills add https://github.com/h-4vok/diagram-tours --skill ux-doc-pass
Repository Details
star Stars 0
call_split Forks 0
navigation Branch main
article Path SKILL.md
More from Creator