How-To Guide Template
A how-to guide template gives you a task-based structure for writing help articles people can actually follow, from the outcome they want to the moment they confirm it worked. Use this free how-to guide template to plan the title, prerequisites, numbered steps, and screenshots, then publish it in your knowledge base where customers and teammates can find it when they are stuck.
Open in Claude
Open in ChatGPT
I need to write a How-To Guide. Act as an expert technical writer and draft one for me. Use this structure, keeping each section clear, concise, and genuinely useful to the reader: 1. Title 2. What you will accomplish 3. Before you start 4. Steps 5. Tips and warnings 6. Verify it worked 7. Related articles Before you begin, ask me for the details you need: the product, team, or audience this is for, and anything specific I should include. Then write the full How-To Guide in clean, well-formatted Markdown.
Write a How-To Guide using the structure below. Keep each section clear, concise, and genuinely useful to the reader. Structure: 1. Title 2. What you will accomplish 3. Before you start 4. Steps 5. Tips and warnings 6. Verify it worked 7. Related articles Use rich formatting so it reads well in a knowledge base: - Clear headings and subheadings for each section. - Callout boxes for asides: a Tip callout for advice, a Note callout for helpful context, and an Important callout for anything a reader must not miss. - Tables for structured or comparison content. - Numbered lists for sequential steps and bulleted lists for options. - Bold for key terms and any values people must not get wrong.
## The how-to guide template
### 1. Title
Name the task the way a reader would search for it, starting with a verb: "Reset your password," "Export a report to CSV," "Invite a teammate." A specific, task-based title is the difference between an article people find and one they scroll past.
| Vague title | Task-based title |
| --- | --- |
| Password help | Reset your password |
| About exports | Export a report to CSV |
| Team settings | Invite a teammate to your workspace |
### 2. What you will accomplish
One or two sentences on the outcome, so a reader can confirm they are in the right place before they start. Set the expectation up front: what they will have when they finish, and roughly how long it takes.
### 3. Before you start
What the reader needs in place first: an account or role, a permission, a setting turned on, or information to have ready. A short checklist here saves a reader from getting three steps in and hitting a wall.
| Requirement | Why it is needed |
| --- | --- |
| Admin access | Only admins can change these settings |
| An active plan | The feature is unavailable on the free tier |
| TODO | TODO |
### 4. Steps
The heart of the guide. Break the task into numbered steps, one action per step, in the order they happen. Show the expected result after each step so the reader knows it worked before moving on, and add a screenshot where a picture removes the guesswork.
1. **Do the first action.** Name the exact button, menu, or field, and where to find it. Follow with what the reader should see happen ("A confirmation banner appears at the top").
2. **Do the next action.** Keep it to a single step. If a step contains an "and," it is probably two steps.
3. **Do the final action.** Add a screenshot or short clip beside anything fiddly, since a picture answers most of the questions you would otherwise field.
### 5. Tips and warnings
Use callouts for the asides that do not belong in a step: a shortcut worth knowing, a common mistake to avoid, or an action that cannot be undone. Keep them close to the step they relate to.
> [!NOTE]
> Use a tip callout for shortcuts, a note for helpful context, and a warning for anything irreversible.
### 6. Verify it worked
Tell the reader how to confirm success in their own account: what they should now see, or a quick check they can run. Ending on a clear confirmation is what turns a set of steps into a guide someone trusts.
### 7. Related articles
Link to the next task a reader is likely to want, plus any prerequisite guide they may have skipped. Cross-linking keeps each article focused on one task and helps people find the neighbouring answer without searching again. The how-to guide template
Copy this structure into a new article and replace the guidance in each section with the specifics of your task. Keep the headings; they are what make one how-to guide feel like the next, and they are what a searcher scans before committing to read.
1. Title
Name the task the way a reader would search for it, starting with a verb: “Reset your password,” “Export a report to CSV,” “Invite a teammate.” A specific, task-based title is the difference between an article people find and one they scroll past.
| Vague title | Task-based title |
|---|---|
| Password help | Reset your password |
| About exports | Export a report to CSV |
| Team settings | Invite a teammate to your workspace |
2. What you will accomplish
One or two sentences on the outcome, so a reader can confirm they are in the right place before they start. Set the expectation up front: what they will have when they finish, and roughly how long it takes.
3. Before you start
What the reader needs in place first: an account or role, a permission, a setting turned on, or information to have ready. A short checklist here saves a reader from getting three steps in and hitting a wall.
| Requirement | Why it is needed |
|---|---|
| Admin access | Only admins can change these settings |
| An active plan | The feature is unavailable on the free tier |
| TODO | TODO |
4. Steps
The heart of the guide. Break the task into numbered steps, one action per step, in the order they happen. Show the expected result after each step so the reader knows it worked before moving on, and add a screenshot where a picture removes the guesswork.
- Do the first action. Name the exact button, menu, or field, and where to find it. Follow with what the reader should see happen (“A confirmation banner appears at the top”).
- Do the next action. Keep it to a single step. If a step contains an “and,” it is probably two steps.
- Do the final action. Add a screenshot or short clip beside anything fiddly, since a picture answers most of the questions you would otherwise field.
5. Tips and warnings
Use callouts for the asides that do not belong in a step: a shortcut worth knowing, a common mistake to avoid, or an action that cannot be undone. Keep them close to the step they relate to.
6. Verify it worked
Tell the reader how to confirm success in their own account: what they should now see, or a quick check they can run. Ending on a clear confirmation is what turns a set of steps into a guide someone trusts.
7. Related articles
Link to the next task a reader is likely to want, plus any prerequisite guide they may have skipped. Cross-linking keeps each article focused on one task and helps people find the neighbouring answer without searching again.
How to fill in this how-to guide template
A template only helps if the finished guide is genuinely followable. A few habits make the difference:
- Write for the reader who is already stuck. They are mid-task and slightly frustrated, so lead with the steps and keep the preamble short.
- One action per step. If a step has an “and” in it, split it. Numbered steps that each do one thing are the easiest to follow under pressure.
- Show the expected result. After each step, say what the reader should see. That is how they know they are still on track.
- Screenshot the fiddly bits. A picture beside a confusing screen removes most of the questions a guide would otherwise generate.
- Test it on someone who has not done it. Watch where they hesitate. The steps you assumed were obvious are usually the ones that trip a first-timer.
For a longer procedure aimed at your own team rather than a customer, an SOP template is a better fit. A how-to guide answers “how do I do this task”; an SOP sets the standard for how your team does it every time.
