Technical & ProductContent Creator

Tutorial page: one task, numbered steps, and a check after each step

A tutorial page teaches one task from start to finish, so a reader can reach a goal without asking for help. It should state the goal and the prerequisites before step one, then give numbered steps that each have one action and a visible result to check. Follow every step yourself on the version readers will use before you share the page.

Quality checklist

Test the tutorial the way a new reader will use it

  • Each step has one action and one visible check.
  • The goal fits in one sentence, and the finished state is described.
  • Everything the reader needs is listed before step one, not discovered in the middle.
  • Someone who did not write the tutorial has completed it from start to finish.
  • Labels match the screen exactly, including capitalization and punctuation.
  • The time estimate comes from timing a full run, not from guessing.
  • Troubleshooting covers the two or three problems readers hit most often.
  • The page states the version and the date it was checked against.
Section outline

Sections for a task readers complete in order

  1. Goal and outcome

    The task in one sentence and what the reader will have when it is done.

    50 words
  2. Before you start

    Access, tools, files and versions the reader needs, each with a link or a note on how to get it.

    90 words
  3. Steps

    Numbered steps with one action each, the exact label the reader will see, and the result to check.

    400 words
  4. If something looks different

    Known variations, such as a menu name on an older version, each with the fix.

    120 words
  5. Finished

    What the reader can now do, and the next task to learn.

    60 words

Total: 720 words

Example excerpt

Sample tutorial: booking a laser cutter safety orientation

Sample section

Illustrative example: the makerspace, its members calendar and its rules are fictional. Goal: Book a 30-minute safety orientation on the laser cutter. Before you start: A member account, a verified email address and a read of the orientation requirements on the members page. Step 1. Open the members calendar from the navigation bar at the top of the page. Check: The calendar shows the current week, with orientation slots in green. Step 2. Select an open orientation slot on a Tuesday or Thursday. Check: A panel opens with the slot time and the name of the instructor. Step 3. Choose Book slot and enter your member number. Check: A confirmation line appears with the time and a reference code. Save the code. Step 4. Choose Add to calendar and open the file it downloads. Check: Your calendar app shows the orientation as a 30-minute event. If the slot is full Choose the next open time. Slots open each Monday at 9 a.m. and close when they fill. If you cannot see the calendar Your account may not be activated yet. Email the front desk with your member number. Do not send your password.

Mistakes to avoid

Ways a tutorial stops working for readers

Combining two actions in one step

A step that says select the slot and confirm hides a click. A reader who stops partway will think they failed. Split it, and the check after each step will catch the mismatch.

Skipping the expected result

Without a result to check, readers cannot tell whether they are still on track. Describe what they should see, such as a label, a color change or a confirmation line.

Running long tutorials without checkpoints

A twelve-step tutorial with checks only at the end lets a reader go wrong at step three and find out at step twelve. Add a stop-here line after any step that changes something the reader cannot easily undo.

Leaving out the version

A tutorial with no version or date sends readers to the wrong steps after an update. State the version each step was checked against, at the top of the page.

Writing from memory

Steps written from memory often skip a click the author no longer notices. Work through the task on the version readers use, with an account they would have, and note any difference you find.

Frequently asked questions

Is a tutorial page the same as a training manual?

Not quite. A training manual usually covers a whole role or subject, and readers dip in and out of it. A tutorial page covers one task from start to finish, and readers follow it in order. If the material is long, split it into one tutorial per task and link them from a manual or an index.

How long should a tutorial page be?

Long enough for every step the task needs and no longer. If the task runs past about ten steps, check whether it is really two tutorials. Time a full run before you publish, and state the time you measured rather than a guess.

Can I start from a tutorial page template?

A template can hold the structure: goal, before you start, numbered steps with checks, and fixes. The steps must come from the task as your readers will do it, so write them from a real run.

Can a tutorial page run the commands it shows?

No. The page displays text for the reader to copy and run in their own environment. It does not run commands, check their output or test the steps for you, so a person has to complete each check.

Browse by category

More references in Technical & Product

How to build it

  1. Follow the eight-step wizard: type, assets and description, images, branding, contact and call to action, Atty Suggestions, blueprint, and generate. Atty generates one HTML page in the background. Review it, then publish and share the page link or download the HTML file.

Attain OS BETA