Supertask

A supertask topic describes a workflow — a sequence of steps in which each step represents a separate task topic.

When to Use Supertask Topic

Supertask topics are intended to organize content. Use this topic type in case you want to describe a procedure that consists of a series of several other procedures.

How to Use Supertask Topic

This topic structure consists of the following elements:

  1. Title — the name of a workflow.

Use a verb-based title that briefly outlines the workflow. Make sure the verb is the first word in the title.

If a workflow involves a procedure that can be performed for only one object of a kind, use the singular form for the object noun (for example, Configuring Veeam Recovery Orchestrator). If a workflow involves a procedure that can be performed for multiple objects, use the plural form for the object noun (for example, Working with Orchestration Plans).

  1. Rationale — reasons behind the workflow.

Describe the workflow and provide the context needed to understand it.

Identify problems that could be solved by completing the workflow. If necessary, add some conceptual background to help users better understand the context of the workflow.

  1. Procedure — a sequence of steps required to complete the workflow.

Begin the procedure with an introductory phrase that starts with an infinitive and ends with a colon. A period at the end of the lead-in phrase is also acceptable. If the procedure applies to multiple objects (for example, if a user can modify and delete a set of objects using the same procedure), clarify that in the introductory phrase.

Use a numbered list to show the order in which the procedure steps must be performed. Each step must describe a particular action and contain a link to the related task topic. If you want to add a description or any other supplementary details for a step, include this information in the step as List Paragraph.

If a step is optional, mark it with the [Optional] tag, and place that tag at the beginning of the step. If different steps must be performed by different subjects (that is, the initiators), make sure you clarify the subject for each step — you can specify the subject in square brackets [ ] at the beginning of the step.

 

Supertask Topic

SupertaskExample 1 (Procedure)

SupertaskExample 2 (Actions)