How-To Guide Template

This guide explains how to {insert a brief description of the task}.

{Overview screenshot}

{Specify when and why your user might want to perform the task.}

Before you start

{Use this section as needed. Remember, this is a how-to; this section should be brief and provide links to additional resources/articles.}

{suggested intros could include}

{insert a brief description of the task}, ensure:

You will need to:

This task requires additional setup:

Before starting, ensure:

Prerequisites include:

  • Prerequisite 1
  • Prerequisite 2
  • Prerequisite 3

{Task name}

{Optional: Provide a concise description of the purpose of this task. Only include this if the purpose is not clear from the task title.}

{You can use this format to describe your steps:}

  1. {Write the step here. Use a verb to start.}

    {Optional: Code sample or screenshot that helps your users complete this step. Do not duplicate screenshots or have screenshots for every step. Only use screenshots for complex how-to guides and narrow the focus to a specific part of the screen.}

    {Optional: The result of completing this step. Not needed for every step. Examples include when printing a report, the report generates as a PDF in a new browser tab, or certification events needing to wait for a response from state edition.}

  2. {Write the step here. Use a verb to start.}

    A. {Substep 1}

    B. {Substep 2}

{Sub-task}

{This section is optional for related tasks after completing the main task. Include a sub-task only if the task is big and complex, or is an alternate way. Include a sub-task for an optional step that requires the context of the same page to be useful.}

What's next

{Include references and/or links to other related documentation such as other how-to guides, conceptual topics, troubleshooting information, and limitation details if any.

  • Reference link
  • Concept link
  • Troubleshooting link