Postrequisite Element (postreq)
The postreq element specifies cleanup tasks, verification steps, or follow-up actions that should be performed after completing the main task.
The postreq element serves these primary purposes:
-
Providing cleanup and maintenance instructions after task completion
-
Specifying next steps or related tasks to be performed
-
Connecting the current task to subsequent activities in a workflow
Key characteristics of the postreq element:
-
An optional element that must be added within
taskbodyin any number -
Is the final element in
taskbody, afterresultorexampleif present -
In general task,
postreqcan be added multiple times per task -
Supports other block elements allowed
-
Can include paragraphs, lists, tables, notes, and examples
-
Can reference related tasks or additional procedures
-
Can include links to other documentation topics
Content within the postreq element follows these guidelines:
-
Appears in a distinct section, often with a heading such as Postrequisites or Next steps
-
Visually separated from the steps and result to indicate supplementary actions
-
May use different styling or indentation than the steps
-
May contain unordered list (
ul) or ordered list (ol) for easy scanning when listing multiple postrequisites
Use postreq to:
-
Provide cleanup instructions for temporary files, connections, or system states
-
Include verification steps to help users confirm successful task completion
-
Reference logical next steps or related tasks to guide the user's workflow
-
Specify safety measures or precautions needed after task completion
A postreq element added to a task topic in the Heretto CCMS Content Editor.
The DITA source of the postreq element with the surrounding context of a task:
<task id="task-6667">
<title>Signing in to MobileView</title>
<shortdesc>Sign in to the MobileView application through the ClusterControl server.</shortdesc>
<prolog>
<author translate="no" type="creator">Heretto User <user@heretto.com></author>
</prolog>
<taskbody>
<prereq>
<p>Ensure you have your username, password, and the name of the server that you want to connect to.</p>
</prereq>
<steps>
<step>
<cmd>To open MobileView, click <menucascade><uicontrol>Start</uicontrol><uicontrol>All programs</uicontrol><uicontrol>Thunderbird MobileView</uicontrol></menucascade>(...)</cmd>
</step>
</steps>
<postreq>
<p>After signing in, verify that the dashboard shows the correct user information and project data.</p>
</postreq>
</taskbody>
</task>