Skip to main content

How-to Template

Type: How-toCreated: Team: Platform
published

Goal​

What you'll accomplish by following this guide, and the end result.

Before you start​

What the reader must have done or know first.

Steps​

Keep each step small and verifiable. Include the exact command, file path, and expected output.

  1. …
  2. …
  3. …

Verification​

How does the reader know it worked?

Troubleshooting​

Common failure modes and how to fix them.

  • Explanation docs — for the why
  • Runbooks — for when it breaks