ux-doc-pass

Review repository documentation for readability and missing prerequisites.

Updated Mar 11, 2026
One-click install
npx skills add https://github.com/h-4vok/diagram-tours --skill ux-doc-pass
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ux-doc-pass
Source: https://github.com/h-4vok/diagram-tours/tree/main/.agents/skills/ux-doc-pass
Command: npx skills add https://github.com/h-4vok/diagram-tours --skill ux-doc-pass

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Clarifies onboarding and contributor-facing documentation to reduce first-run confusion.

Core Features & Use Cases

  • UX-focused review of README and contributor-facing docs to surface ambiguities, missing prerequisites, and unclear terminology.
  • Prioritizes critical files such as README.md, docs/adoption-onboarding.md, docs/authoring-guide.md, docs/runtime-loading.md, and docs/testing/smoke-tests.md for rapid improvement.
  • Generates actionable recommendations and tighter wording to improve GitHub readability and contributor confidence.

Quick Start

Follow the steps to run a UX doc pass and return a prioritized list of readability improvements for the repository docs.

Frequently Asked Questions about ux-doc-pass

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I improve onboarding docs and reduce first-run confusion for new contributors?

To improve onboarding docs and reduce first-run confusion, perform a UX-focused review of contributor-facing documentation to surface ambiguities, missing prerequisites, and unclear terminology. This process generates actionable recommendations and tighter wording for better readability.

What is the best way to review a repository README for usability issues?

The best way to review a repository README for usability issues is to run a UX doc pass that prioritizes critical files like README.md and onboarding guides. This surfaces readability problems and enforces a structured Markdown guide with Quick Start instructions.

How do I check if my developer documentation has missing prerequisites?

You can check for missing prerequisites in developer documentation by applying a UX doc pass to critical files like authoring guides and runtime-loading docs. This surfaces readability issues and enforces a three-section Markdown guide with a Quick Start instruction.

Does a UX documentation review require any specific dependencies or components?

A UX documentation review requires no specific dependencies or components to function. You can run the UX doc pass directly on repository files like README.md and contributor guides to return a prioritized list of readability improvements.

What files should I prioritize when fixing contributor-facing documentation?

When fixing contributor-facing documentation, prioritize critical files such as README.md, docs/adoption-onboarding.md, docs/authoring-guide.md, docs/runtime-loading.md, and docs/testing/smoke-tests.md to rapidly improve GitHub readability and contributor confidence.

Why does my onboarding documentation need a three-section Markdown guide?

Your onboarding documentation needs a three-section Markdown guide to satisfy the frontmatter requirement for a name and description in SKILL.md. This structure enforces Quick Start instructions, which reduces first-run confusion for new contributors.