Skip to content

How-To Tutorial

Task-first writing that takes a reader from “I don’t know how” to “I did it” by organizing every decision around user goals, not system features.

A how-to tutorial is a success contract with the reader. It opens with the task - not the history of the technology, not the theory of operation, not a context-setting paragraph about why this matters. The reader is already motivated; they arrived because they want to do something. Every word that precedes the first step is a word the reader skips.

Step numbers are sacred in this structure. Each numbered step contains exactly one action. Not one concept, not one paragraph of background, not two related actions that happen to be adjacent in the interface - one action. “Click Save” is a step. “Configure your settings and save” is two steps. When steps contain multiple actions, readers lose their place, skip one, and then blame themselves for the failure that follows.

The test of a how-to tutorial is functional: can a reader complete the task by following it? If the tutorial passes this test, it succeeds regardless of prose elegance. If it fails this test, no amount of clarity in the writing rescues it. This is the axis of quality that distinguishes how-to writing from all other expository forms.

  • Opens with a one-sentence statement of the task goal, not background context
  • Each numbered step contains exactly one action
  • Prerequisites listed before step one, not embedded inside steps
  • Expected outcomes or confirmation signals follow steps where the result is not obvious
  • Warnings and cautions precede the step they apply to, never follow it
  • Ends with confirmation that the task is complete, not a summary of what was done

When the reader needs to accomplish a specific, bounded task with a verifiable outcome. Ideal for onboarding flows where a quick first success builds confidence, for troubleshooting guides where each resolution path is a distinct task, and for any procedure with a fixed sequence that must be followed in order.

When the reader needs to understand how a system works rather than just operate it. Avoid when the subject is conceptual, when the correct procedure depends heavily on context the tutorial cannot anticipate, or when the goal is to build judgment and reasoning rather than execute a fixed sequence.

technical-writer, instructional, friendly-mentor

diataxis-explanation: A Diataxis explanation is designed to build understanding - it answers “how does this work?” A how-to tutorial is designed to produce a completed action - it answers “how do I do this?” The distinction is functional: explanations serve comprehension; tutorials serve task completion. The same subject can yield two completely different documents depending on which goal governs the writing.

Write as a how-to tutorial. The very first line states the task goal in one sentence. List any
prerequisites before step one. Number every step and put exactly one action in each step - not
one paragraph, not one concept, one action. Where the result of a step is not obvious, add a
brief expected-outcome note after the step. Put warnings before the step they apply to. Close
with a one-sentence confirmation that the task is now complete. Do not add background context,
explanatory asides, or section headers that delay the steps.

Technical Writer, Instructional, Friendly Mentor

Columnist, Devotional Reflection, Reverent

Diataxis Explanation

How to roll out an async standup in your team

Section titled “How to roll out an async standup in your team”

This guide walks a team lead through replacing a synchronous daily standup with an async update across four timezones. It is written for a lead running an 11-person engineering team distributed across US Pacific, US Eastern, UK, and India.

Before you start, confirm the following:

  • Your team has a shared Slack workspace (or equivalent) where you can create a dedicated channel.
  • You have a recurring sync meeting slot you can repurpose. You will not delete it - you will reuse the time.
  • You have at least two weeks of attendance data showing the cost of the current schedule. This makes the case if anyone resists.
  • Your manager is informed. Async standups are not controversial, but they look like a meeting being cancelled, and that is a thing managers like to know.

Create #team-standup in Slack. Set the channel description to: “Daily async standup. Post by 10am your local time. Three fields: Shipped, In progress, Blocked or at risk.”

Pin a message to the channel with the exact three-field template:

Shipped: [what merged or shipped in the last 24h]
In progress: [what you are working on today]
Blocked or at risk: [what is stuck, @mention who can unblock]

A pinned template removes the need for anyone to remember the format.

Post in the team channel that the team will run async standups for 30 days, with a revert option. Name the start date. Name the success criteria: blocker resolution time, channel engagement, team survey.

Cancel the recurring 9am Pacific standup on the calendar. Do not just stop attending. Cancelling the invite signals the change is real.

Add a recurring 60-minute Thursday meeting at a time that works for all four timezones. This is your new sync slot. Use it for discussion that needs real-time exchange.

On day one, post your own update by 9am Pacific before anyone else. Modeling is faster than instructing.

When you see a blocked item without an @mention, reply in thread and ask who owns it. Do this for the first week. After that the pattern is self-sustaining.

After 30 days, check three things:

  • Median time from “Blocked” post to first reply from the unblocker. Target: under 2 hours during overlap windows.
  • Number of team members posting at least 4 of 5 weekdays. Target: 9 of 11.
  • A short survey: “Do you have more or less context on what your teammates are doing than 30 days ago?”

If two of three are positive, keep the change. If two of three are negative, revert and write up what you learned.