Docs
How-to guide template
One task explained start to finish, with prerequisites, numbered steps and fixes for common errors.
How to set up your local dev environment
Before you start
Steps
git clone git@github.com:example/app.git
cd appcp .env.example .envdocker compose up -dbun install
bun run db:seedbun devdemo@example.com and password demoCheck it worked
Common problems
Port 5432 is already in use
docker-compose.yml and in .env.db:seed fails with "relation does not exist"
bun run db:migrate first, then seed again.What it is
A how-to guide walks someone through one task from start to finish. It lists what they need before starting, numbered steps with the exact commands or clicks, a way to check it worked and fixes for the errors people hit most. It assumes the reader wants the task done, not the background.
When to use it
- Setup instructions for new team members
- Help articles for customers
- Any task people ask you to explain more than twice
How to use it
- 01
Keep one task per page
If the guide covers two tasks, split it into two pages and link them with @.
- 02
Put commands in code blocks
Use a code block with the right language under each step, so people can copy it.
- 03
Add a check
End with to-dos that confirm it worked. Readers tick them as they go.
- 04
Publish it
Publish the page to give customers a read-only link, or keep it inside the team wiki.
Or have the AI draft your version
"Write a how-to guide for setting up two-factor sign-in on a company laptop, with prerequisites, numbered steps, a check that it worked and three common problems with fixes."
Related templates
All templatesDocs
Standard operating procedure (SOP)
A repeatable process written as numbered steps with an owner, inputs and what done looks like.
Team
Team wiki
A home page for the team with sub-pages for how you work, tools, meetings and the words you use.
- How the AI works
Draft your own with AI
Describe the page you need in one sentence. The AI writes it, and you edit it like any other page.