diataxis:how-to

Included with Lifetime

$97 forever

Use when the user asks for a how-to guide, step-by-step instructions for a specific goal, troubleshooting guide, configuration guide, deployment steps, migration guide, or operational runbook. Creates goal-oriented guides for competent users who know what they want to achieve. The reader already understands the basics — this is about getting work done. Do not use for beginner onboarding (use tutorial) or conceptual background (use explanation).

General

What this skill does


# How-to guide writer

## Purpose

Create a goal-oriented guide that helps a competent user get something done.

A how-to guide is about work, not study. It is not a tutorial.

## When to use

Use this skill when the user asks for:

- how to do a specific task
- troubleshooting a known problem
- configuration for a concrete outcome
- deployment or migration steps
- operational procedures

Do not use this skill for beginner onboarding or conceptual background.

## Core stance

Assume the reader:

- already understands the basics
- knows what outcome they want
- can apply judgement while following guidance

## What a good how-to guide does

- addresses a real task, goal, or problem
- keeps a tight focus on the outcome
- contains action and only action
- avoids teaching, essays, and filler
- links out for reference or explanation when needed

## Scope rules

Good scopes:

- Configure token refresh for Android clients
- Migrate from v1 config to v2
- Diagnose webhook signature failures
- Deploy with Docker Compose behind Traefik

Bad scopes:

- Learn Android networking
- Build a web app
- Understand authentication

## Structure

Use this structure unless the task genuinely needs branching:

1. Title in "How to..." form
2. When to use this guide
3. Assumptions / prerequisites
4. Steps
5. Validation or verification
6. Recovery / troubleshooting notes if essential
7. Links to reference and explanation

## Writing rules

- start with the outcome
- prefer direct imperative steps
- skip obvious hand-holding
- include only decisions relevant to the goal
- use branches only when reality demands them
- include verification steps so the user knows they succeeded

## Handling non-linear tasks

A how-to guide does not have to be perfectly linear.
If the task has forks, entry points, or judgement calls:

- make decision points explicit
- separate branches clearly
- explain which path to choose in one line
- return to the main flow quickly

## Inputs to gather

- exact task or problem
- user environment
- assumptions about baseline competence
- required prerequisites
- success criteria
- common failure conditions

## Output contract

Produce a guide that:

- gets a competent reader to a specific result
- stays tightly on-task
- avoids tutorial-style teaching
- avoids reference-dump behaviour
- includes a clear success check

## Anti-patterns to remove

- broad "getting started" framing
- large conceptual sections
- exhaustive command flag explanations
- multiple unrelated goals in one page
- step narration that insults the reader's competence

## Final self-check

Before returning, verify:

- the guide solves one concrete problem
- the target reader is already competent
- every paragraph serves the task
- the user can verify success
- supporting facts live in reference, not inline unless essential

Files: 1

Size: 3.2 KB

Complexity: 10/100

Category: General

Source: https://github.com/jayteealao/agent-skills/tree/main/plugins/diataxis/skills/how-to-guide-writer

Related in General

modeling-omnistudio-epc-catalog

Included

Salesforce Industries CME EPC product-modeling skill for Product2-based catalog creation. Use when creating EPC products, configuring product attributes, building offer bundles with Product Child Items, or reviewing EPC DataPack JSON metadata for product catalog changes. TRIGGER when: user creates or updates Product2 EPC records, AttributeAssignment payloads, AttributeMetadata/AttributeDefaultValues, Offer bundles, or ProductChildItem relationships. DO NOT TRIGGER when: designing OmniScripts/FlexCards/Integration Procedures (use building-omnistudio-omniscript, building-omnistudio-flexcard, or building-omnistudio-integration-procedure), implementing Apex business logic (use generating-apex), or troubleshooting deployment pipelines (use deploying-metadata).

Generalscripts

relationship-science-coach

Included

Use this skill for direct, practical adult relationship coaching: couples conflict, repair, trust, marriage, dating, flirting, attachment patterns, emotional connection, sex, desire differences, eroticism, kink negotiation, affection, love languages, breakups, and long-term passion. Draw on Gottman, EFT and Hold Me Tight, attachment science, modern sex research, Perel, Nagoski, Kerner, Schnarch, Love and Stosny, and flexible love-language tools. Be concrete and low-hedge. Redirect only for imminent danger, abuse, coercive control, minors, non-consent, self-harm, stalking, or medical/legal/psychiatric decisions.

Generalscripts

building-sf-integrations

Included

Salesforce integration architecture and runtime plumbing with 120-point scoring. Use this skill to set up Named Credentials, External Credentials, External Services, REST/SOAP callout patterns, Platform Events, and Change Data Capture. TRIGGER when: user sets up Named Credentials, External Services, REST/SOAP callouts, Platform Events, CDC, or touches .namedCredential-meta.xml files. DO NOT TRIGGER when: Connected App/OAuth config (use configuring-connected-apps), Apex-only logic (use generating-apex), or data import/export (use handling-sf-data).

Generalscripts

venue-templates

Included

Access comprehensive LaTeX templates, formatting requirements, and submission guidelines for major scientific publication venues (Nature, Science, PLOS, IEEE, ACM), academic conferences (NeurIPS, ICML, CVPR, CHI), research posters, and grant proposals (NSF, NIH, DOE, DARPA). This skill should be used when preparing manuscripts for journal submission, conference papers, research posters, or grant proposals and need venue-specific formatting requirements and templates.

Generalscripts

let-fate-decide

Included

Draws the 12 Houses of the Zodiac Tarot spread to inject entropy into planning when prompts are vague, ambiguous, or casually delegated. Interprets the spread to guide next steps. Use when the user says 'let fate decide', 'YOLO', 'whatever', 'idk', or other nonchalant phrases, makes Yu-Gi-Oh references, or when you are about to arbitrarily pick between multiple reasonable approaches. Prefer over ask-questions-if-underspecified when the user's tone is casual or playful rather than precision-seeking.

Generalscripts

net-ops

Included

Cross-platform network troubleshooting (Windows, macOS, Linux) via local or remote shell. Use for: DNS broken, can't resolve hostnames, nslookup/dig works but apps fail, NRPT, WFP, scutil, /etc/resolver, systemd-resolved, /etc/resolv.conf, NetworkManager, VPN DNS leak residue (ProtonVPN/Mullvad/WireGuard/AnyConnect), AV/firewall blocking DNS or DoH, Tailscale DNS interaction, intermittent connectivity, remote diagnostics over SSH.

Generalscripts