new-guide

Draft user-facing guides in the correct Diátaxis quadrant.

15|5|Updated May 4, 2026
One-click install
npx skills add https://github.com/eugenelim/agent-ready-repo --skill new-guide
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: new-guide
Source: https://github.com/eugenelim/agent-ready-repo/tree/main/.agents/skills/new-guide
Command: npx skills add https://github.com/eugenelim/agent-ready-repo --skill new-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

This skill helps you create a new user-facing guide that lands in the correct Diátaxis quadrant without blending tutorials, how-tos, references, or explanations into one page.

Core Features & Use Cases

  • Audience contract first: It forces you to identify the reader posture, the quadrant, and the working title before any body text is written.
  • Template-driven drafting: It scaffolds the new guide from the matching quadrant template and keeps the structure aligned with the chosen doc type.
  • Link-out discipline: It tells you when to split adjacent material into a separate page and link to it instead of mixing modes.
  • Prose and cross-link checks: It applies a clear-prose pass, then adds only the sibling links that already exist.
  • Use case: Use it when you need to write a new guide for a shipped feature, such as a setup tutorial, a task-focused how-to, a neutral reference page, or a conceptual explanation.

Quick Start

Ask the new-guide skill to draft a guide for a real user-facing task and confirm the audience contract before any body text is written.

Frequently Asked Questions about new-guide

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

FAQPage Schema
How do I write a new user-facing guide in the correct Diátaxis quadrant?

Writing a new user-facing guide in the correct Diátaxis quadrant requires defining an audience contract for reader posture before drafting body text from a quadrant-specific scaffold, ensuring the page stays purely tutorial, how-to, reference, or explanation.

What is the Diátaxis framework for documentation?

The Diátaxis framework structures documentation into four distinct quadrants—tutorials, how-to guides, reference, and explanation—matching each page to a specific reader posture to prevent mixing modes and confusing the audience.

When should I split documentation into a separate page instead of mixing modes?

Split documentation into a separate page instead of mixing modes when adjacent material belongs to a different Diátaxis quadrant, applying link-out discipline to cross-link existing sibling pages rather than blending reference and tutorial content together.

How do I structure a tutorial versus a reference page for shipped features?

Structure a tutorial versus a reference page for shipped features by establishing an audience contract for reader posture, then applying a template-driven scaffold that keeps tutorials action-oriented and reference pages neutral without blending adjacent forms.

Do I need existing sibling pages before writing a new guide?

You do not need existing sibling pages before writing a new guide, but cross-link checks only add links to sibling pages that already exist within the repository, ensuring your new documentation connects safely without creating broken links.