new-guide

Solid

Create or substantially revise user guides, pack pages, and journey pages using Diátaxis plus conversation-first UX. Use when asked to write, simplify, restructure, audit, or modernize tutorials, how-to guides, reference pages, explanations, pack pages, or journey pages so readers can start from a natural-language goal, see what to say, understand what happens next, and reach an outcome without learning internal skill names first. Do NOT use for feature contracts (use `new-spec`), cross-cutting proposals (use `new-rfc`), recording decisions (use `new-adr`), minor single-line edits (normal PR), contributor docs, docstrings, release notes, or blog posts.

Code & Development 14 stars 4 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 80/100

Stars 20%
39
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Guide authoring **Diátaxis determines where information lives. User intent determines how readers enter it.** A reader who does not know any pack or skill names must still be able to begin a real task from the first screen. Create or substantially revise one user-facing documentation surface. Use Diátaxis to determine the page's job. Use conversation-first design to determine what the reader encounters first. ## Prerequisites - Read the actual skills, commands, or workflows the page documents. - Identify one primary reader and one primary job. - Preserve verified commands, permissions, defaults, and side effects. - For generated pages, edit their source data or template — not the rendered output. ## Procedure ### Step 1 — Choose mode **Create** a new guide, or **revise** an existing one. Revise mode applies to substantial changes: restructuring the page's flow, correcting the quadrant, major rewrites, adding conversation-first structure, or auditing for inventory-first writing. Minor edits — a typo fix, a single updated command, a broken link, a version number — are a **normal PR against the existing file**. Stop here and redirect to that path; do not proceed with this skill for minor edits. ### Step 2 — Pick the slug or confirm the file - **Create:** choose a kebab-case slug matching what the reader would have searched for. `rotate-credential-token`, not `how-to-rotate-your-token-step-by-step`. The quadrant subdir carries the "how-to" / "tutorial" framing; ...

Details

Author
eugenelim
Repository
eugenelim/agent-ready-repo
Created
2 months ago
Last Updated
today
Language
Python
License
Apache-2.0

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

writing-docs

Use when writing, restructuring, or reviewing any prose documentation — a tutorial, how-to guide, reference page, or explanation/conceptual doc — for a public docs site (e.g. Mintlify MDX, docs/, README material), a getting-started guide, an API/CLI reference page, or a "why we built it this way" conceptual page. Applies the Diátaxis framework (see https://diataxis.fr/) — every document belongs to exactly one of the four quadrants (tutorial / how-to guide / reference / explanation), and mixing quadrants inside one document is the single most common documentation failure. Covers the four-quadrant compass for picking the right form, per-quadrant structure templates, an anti-pattern list for quadrant drift, and generic voice/craft rules — repo-specific voice and target output format (e.g. Mintlify MDX) are resolved from the repo's docs-manifest (falling back to project-context), never hardcoded here.

3 Updated today
whimzyLive
Data & Documents Listed

research-to-guide

Transform already validated research into a clear, evidence-faithful user guide without losing claims, limitations, sources, application, or prototypes. Owns reader contract, composition, narrative style, examples, prototype, and coverage audit. Use to rewrite, convert, expand, structure, or turn a research report, technical analysis, market study, domain review, literature review, findings file, or baseline document into a guide, playbook, handbook, tutorial, decision guide, or separate user-facing MD. Responsibility boundary: does not conduct the primary research and does not choose PDF typography/layout; use `researcher` before it and `guide-pdf` after it. Triggers: 'turn this research into a guide', 'make a user-friendly MD', 'переработай исследование в гайд', 'добавь применение и прототип', 'не потеряй важное'.

0 Updated 5 days ago
createusernam
Code & Development Listed

project-guides

Create verified project documentation from the real repository: a self-contained visual GUIDE.html for operators, a cited DEVELOPER-INDEX.md for maintainers, and optionally AI-CONTEXT.md. Use when Codex is asked to document a project, create a user guide, build a developer index or technical reference, generate the two companion guides, or prepare durable context for a future coding session.

0 Updated 1 weeks ago
ojesusmp