Show/Hide Toolbars

Technical Writers’ Companion

Navigation: Writing > Writing topics

Writing “Task” topics

Scroll Prev Up Next More

“Task” topics describe how to accomplish a specific job. The goal is to enable users to accomplish the job without reading a large amount of text.

Typically, Task topics consist of:

Optional: A brief description why the task needs to be performed.

Optional: Prerequisites that must be fulfilled before the task can be performed.

Required: A series of steps that users can follow to produce the intended outcome (see Writing procedures).

Required: Warnings if the procedure involves any dangers (see Writing warnings).

Required: A brief description or picture of the procedure’s result so that readers can verify that they’ve followed all steps correctly.

Optional: Links to related Concept topics and Reference topics.

Optional: Link to a Task topic that describes the subsequent task within a larger context or workflow.

Expand /Collapse All Subsections

© indoition publishing e.K., all rights reserved – Imprint and Terms of Use | Privacy Policy