_otherCerts
(Enter the title for the task topic in the New Page box at the top of the page. The title of a task topic begins with a gerund. After conferring with your pillar information architect, add metadata values, as appropriate for the topic.)
Writer: Throughout the topic, you should link liberally to help users find related information. Use the following graphic to add the following types of links. The colors indicate where you might put that type of link. These are suggestions but help you to be consistent about where you add links. Some links can go in multiple places. If the link is to something the user is very likely to use (such as a reference topic or a task that documents a step in more detail), you might put the link inline with the step or other content.
(recommended) Contextual information related to the task. Include links to contextualizing topics, such as a process overview or a use case. Provide context so that users understand where they are if they happen upon this topic from a search. Do not assume users have read preceding topics.
Before you begin (recommended)
In general, every task should have prerequisites (mostly like with linking text to required tasks). Not including this section should be the exception. See Prerequisites (Before you begin).
To do something (Begin the procedure title with an infinitive.)
(not recommended) Topics should provide context. But if the task topic does not contain any contextual or prerequisite information, you can omit the procedure title.
(optional) Body text to introduce the procedure
Writer: Add links in the procedures to fill in knowledge gaps, such as a step that summarizes a procedure explained elsewhere, a reference topic, or a concept topic that explains some key term or idea used in the procedure.
- Step text (In the Console component, select Reports.)
Writer: If you're adding an image, it should be informative, so avoid using unreadable thumbnails that require an extra action to view. See Using-graphics and Screenshot-policy. - Step text
- Substep text
- Substep text
- Step text
- Choice text
Choice text
To do something else (optional)
(optional) Body text to introduce the procedure
Step text
Step text
Result (optional)
Result of performing the task
Example (optional)
Example that illustrates or supports the task
Troubleshooting (optional)
Information about what to do if this procedure does not work
Where to go from here
Information about what tasks to perform next. If the current task is part of a larger process, this section must provide navigation to the next possible task or tasks. You can omit this section if it is the last task in the process, but you must clearly state that the goal has been reached.
If more than one next task is given, provide the context so users know the condition for which task to complete next.
Related topics
Links to related topics
For guidelines, see Linking.
(After conferring with your pillar information architect, add metadata values, as appropriate for the topic.)