Guideway / note 1

Writing a task-based product guide

Start with create a view. The entry pairs “Choose fields” with “Task 1”. That pairing is useful only when it is clear why the context supports the state. A feature catalogue describes what exists. A useful guide starts with what the reader is trying to accomplish.

Begin with the constraint

Write around a task and its starting conditions. Include a recognisable stopping point and a recovery route for mistakes.

Example: Create a view

The illustrative record contains choose fields. Its state is task 1. Ask what evidence supports that state, which detail is still uncertain and whether the next person could understand it without reading a separate message thread.

Questions for a working review

A small exercise

Take one recent customer guides example from your own process. Write its context without using a status label, then add the label separately. If the two contradict each other, investigate the source before updating the record. Compare the result with “Share a result” in the demonstration to see which distinctions your process needs.

These are planning notes. The specimen is illustrative, and the preview does not process live work.

More resources →