How to write a guide
Create a guide in Etch Studio: fill in its details, pick prerequisites, add steps with screenshots, then publish.
Introduction
Every guide on this wiki is a Guide entry in the Content Hub. Its details (number, summary, facts and prerequisites) are fields you fill in. Its steps are Guide Step components you add in the builder. Follow these steps for each new guide.
What you need
- An Etch Studio login for this site
- Screenshots for each step of the task
- The guide's place in the term timeline
Create the guide
- Open the Content Hub, choose Guides, then click New.
- Type the guide's name as the title. The page address comes from it: "Color coding" becomes /guides/color-coding/.
- Renaming a guide later changes its address and breaks old links to it.
Fill in the guide details
- Number: two digits, e.g. 07. Guides are listed in number order.
- Summary: one sentence. It shows under the title and in guide lists.
- Phase: Term setup or Processing.
- Location: Oak Glen or Local. Choose All to list the guide under every location.
- Difficulty, Time required, Who and Due by fill the facts strip at the top of the guide.
- Leave Due by blank if it doesn't apply; the facts strip hides it.
- Introduction: a short paragraph on what the task is and why it matters.
- Video URL: optional link to a video version of the guide.
Add prerequisites
- In Prerequisites, pick everything someone needs before they start.
- If one isn't listed, add it under Content Hub › Prerequisites. Its title is the text shown on the guide.
- Set Linked guide when another guide covers it. The row becomes a link to that guide.
- Leave Linked guide blank for plain action items, like "The current LRC list". They show as text.
- Reuse an existing prerequisite instead of making a duplicate, so one fix updates every guide.
Link the next guide
- In Next guide, pick the guide people usually do after this one. It appears as a card at the end.
- Leave it blank on the last guide in a sequence.
Add the steps
- Open the guide in the builder.
- Insert one Guide Step component per step, in order.
- Set Number (01, 02, …) and Title. Keep Tag on li and Heading Level on h2.
- Under Lines, add one row per instruction.
- Start each line with a verb and keep it to one action.
- Type: default for an instruction, note for a tip, caution for anything that can break things.
- Level 1 indents a line under the one above it.
Add screenshots
- Upload screenshots in the Asset Manager and add them to the Screenshots collection.
- Choose up to three in the step's Screenshot 1–3. Screenshot 1 is shown large; 2 and 3 sit beside it.
- Crop to the part of the screen that matters, and blur names, emails and phone numbers.
Check and publish
- Save, then preview the guide and click through every step and link.
- Deploy the site so the team sees the new guide.
Finished?
Ask your subteam leader to review the guide before you share it.