Step Element (step)
The step element represents a single action within a task procedure. It contains a required command element (cmd) and optional supporting information to help users complete tasks successfully.
The step element serves these primary purposes:
-
Providing a single, distinct action within a procedural task
-
Organizing actions and supporting information related to the step in a structured format
Key characteristics of the step element:
-
A required element that must be added within a
steps,steps-unordered, orsubstepselement -
Can be marked as optional or required (with the
importanceattribute) Must contain a
cmdelement that describes the action to be performed-
Can include a
noteorhazardstatementbeforecmdto provide important information or warnings -
Can include other optional elements that provide context, examples, or results
-
Can include substeps for complex actions that require multiple sub-actions
-
Can include choices when users must select from multiple options
A step element consists of these optional and required components:
- Note (
note) - An optional element used to provide supplementary information, tips, or important considerations related to the step. Notes can be typed (using the
typeattribute), for example, astip,important,caution, orwarning. - Hazard Statement (
hazardstatement) - An optional element used to present safety messages that require special attention. Hazard statements have a required
typeattribute (with valuescaution,danger,notice, orwarning) and include elements for the hazard symbol, message, and consequences. - Command (
cmd) -
A required element that specifies what the user needs to do. Should be written as a clear, actionable instruction.
- Information (
info) -
An optional element that provides additional information or context that helps users understand or complete the command but isn't part of the command itself.
- Substeps (
substeps) -
An optional container element that groups a series of subordinate steps (
substep) required to complete the parent step. Substeps have their own sequence and numbering, typically different than the main steps. - Substep (
substep) -
A required element within the
substepselement that represents a single subordinate step required to complete the parent step. Each substep must contain acmdelement and can include optional elements likeinfo,stepxmp, orstepresult. - Step Example (
stepxmp) -
An optional element that illustrates how to perform the step.
- Choices (
choices) -
An optional container element used within a step when users must choose one option from a list of mutually exclusive options. Each option is represented by a
choiceelement and typically triggers a single action. Used for simpler decision points compared to choice tables. - Choice Table (
choicetable) -
An optional element used to present complex choices in a tabular format, with each row representing a different option and columns showing details about each option. Used when options trigger multiple actions or require detailed explanation.
- Step Result (
stepresult) -
An optional element that describes what happens after completing the step, such as system responses or changes to the interface.
Content within the step element typically follows these output formatting rules:
-
Steps are automatically numbered when contained in a
stepselement -
Steps typically appear as bullets when contained in a
steps-unorderedelement -
Steps marked as required or optional (with the
importanceattribute) typically appear with a label like Required or Optional Supporting elements like
info,stepxmp, andstepresulttypically appear on new lines after the command-
Substeps are indented and may use different numbering formats than parent steps (such as letters or roman numerals)
-
Choices are typically presented as bullets
Use step to:
-
Present a clear, distinct action as part of a sequential or non-sequential procedure
-
Provide supporting information directly related to a specific action
-
Break down complex tasks into manageable individual actions
-
Guide users through decision points with multiple options
A number of step elements containing various supporting elements in a task topic in the Heretto CCMS Content Editor.
A number of step elements containing various supporting elements in a task topic:
<task id="configure-network">
<title>Configuring Network Settings</title>
<shortdesc>Configure network settings to connect your device to the internet.</shortdesc>
<taskbody>
<prereq>
<p>Ensure your device is powered on and you have administrator privileges.</p>
</prereq>
<steps>
<step>
<cmd>Open the Control Panel.</cmd>
<info>You can access the Control Panel from the Start menu or by using the search function.</info>
<stepxmp>
<p>Click <uicontrol>Start</uicontrol> and then select <uicontrol>Control Panel</uicontrol> from the menu.</p>
</stepxmp>
</step>
<step>
<cmd>Navigate to the Network and Internet settings.</cmd>
<stepresult>The Network and Internet settings panel appears, showing various network-related options.</stepresult>
</step>
<step>
<cmd>Select your connection type based on your network infrastructure.</cmd>
<note type="tip">If you are unsure which connection type to choose, check your device manual or contact your network administrator.</note>
<choices>
<choice>For a wired connection, select <uicontrol>Ethernet</uicontrol>.</choice>
<choice>For a wireless connection, select <uicontrol>Wi-Fi</uicontrol>.</choice>
</choices>
</step>
<step>
<cmd>Configure the IP address settings.</cmd>
<hazardstatement type="caution">
<messagepanel>
<typeofhazard>Network Configuration Risk</typeofhazard>
<howtoavoid>Incorrect IP settings may disconnect your device from the network. Note your current settings before making changes.</howtoavoid>
</messagepanel>
</hazardstatement>
<substeps>
<substep>
<cmd>Click <uicontrol>Properties</uicontrol>.</cmd>
</substep>
<substep>
<cmd>Select <uicontrol>Internet Protocol Version 4 (TCP/IPv4)</uicontrol>.</cmd>
</substep>
<substep>
<cmd>Click <uicontrol>Properties</uicontrol> again.</cmd>
</substep>
</substeps>
<stepresult>The IP settings dialog box appears.</stepresult>
</step>
</steps>
<result>
<p>Your network settings are now configured, and your device should be connected to the network.</p>
</result>
</taskbody>
</task>