Guide Template

How to contribute a guide page to the Guardian docs

Guide Template Use for: multi-phase walkthroughs toward a larger goal — deploying Guardian to production, digitizing a methodology, authoring and publishing a policy. Guides are longer than task pages and are organized into named parts with checkpoints. Each step within a part follows the same conventions as the task template. Guides live in the Guides tab, not the Docs tab.

Guide Page Title: Name the goal, not the tool — e.g. "Digitize a Verra VCS methodology", "Deploy Guardian to production", "Author and publish your first policy"

---

One sentence. Name the role and what they will have accomplished by the end. Example: By the end of this guide, you will have a published Policy Integrity Test running against your policy on mainnet.

Who this guide is for

One sentence naming the role and the context in which they would use this guide.

What you will accomplish

• Outcome one

• Outcome two

• Outcome three

Before you start

• Prerequisite one

• Prerequisite two

• Link to any concept pages the reader should understand first

---

Part 1: Name of the first major phase

Brief orientation sentence for this part — what it covers and why it comes first.

Step 1.1 — Action

What to do and why, in plain language.

Step 1.2 — Action

---

Checkpoint

What the reader should have or see at this point before moving on.

---

Part 2: Name of the second major phase

Brief orientation sentence.

Step 2.1 — Action

Step 2.2 — Action

---

Checkpoint

What the reader should have or see at this point.

---

Next steps

Where to go from here.

• Guide: the natural follow-on guide

• Task: a specific task introduced in this guide

Related

• Concept: background reading

• Reference: specs referenced in this guide