HelpArticle template

Article template

Reuse this template for new support articles. Copy the structure, replace placeholders, and remove sections that do not apply.


Title: <describe the task>

Applies to: Plan(s) · Role(s) · Platform(s)

Summary: One sentence that states the problem and the outcome this guide delivers.

Steps

  1. Step one with UI location or API call.
  2. Step two with expected change.
  3. Step three with validation tip.
  4. Add more steps as needed.

Expected result

Explain what users should see or measure when the steps succeed.

If it fails

  • List error messages, logs, or metrics to capture.
  • Provide immediate workarounds or escalation paths.
  • Link to complementary guides, API references, or training videos.
  • Include Jira/Asana task templates if relevant.

Last reviewed: Owner · YYYY-MM-DD