Template text
# [Product name] user manual
| Field | Value |
|---|---|
| Product and version | [Product name, version 1.0] |
| Manual version | [1.0] |
| Date | [YYYY-MM-DD] |
| Owner | [name, role] |
| Next review | [YYYY-MM-DD] |
## 1. About this manual
- Who it is for: [example: new accounting staff who use the invoicing screen]
- What the product does: [one or two sentences]
- What this manual does not cover: [example: administrator settings]
## 2. Before you start
- [Account or permission you need]
- [Browser, device or software you need]
- [Information to have at hand: example, your customer number]
## 3. Getting started
1. [Open the product: address or where to find it.]
2. [Sign in: which account to use.]
3. [What the first screen shows and where the main menu is.]
[Screenshot: first screen, main menu marked]
## 4. Tasks
### How to [task 1: start with a verb, example: create an invoice]
When to use it: [one sentence]
1. [Start with a verb. Example: Click New invoice.]
[Screenshot: button marked]
2. [One action per step.]
[Screenshot]
3. [Say what the reader should see when it worked.]
Note: [a warning or tip that belongs to this task]
### How to [task 2]
1. [...]
2. [...]
[Copy this block for each task. Put the tasks in the order a new user meets them.]
## 5. Settings
| Setting | What it does | Default |
|---|---|---|
| [Setting name] | [Effect in one sentence] | [Default value] |
## 6. Troubleshooting
| Problem | Likely cause | What to do |
|---|---|---|
| [Error message or what the user sees] | [Cause] | [Fix, step by step] |
## 7. Frequently asked questions
**[Question in the user's own words]**
[Short answer.]
## 8. Glossary
| Term | Meaning |
|---|---|
| [Term used in the product] | [Plain explanation] |
## 9. Support
- Who to ask: [person, team or channel]
- What to include in a request: [example: screenshot, time, what you were doing]
## 10. Revision history
| Version | Date | Changed by | Change |
|---|---|---|---|
| [1.0] | [YYYY-MM-DD] | [name] | [First release] |
The Word file also opens in Google Docs: upload it to Google Drive and open it with Google Docs. user-manual-template.md · A plain Markdown file that opens in any editor.
Instead of filling in this template by hand, do the task once and let Izly write the steps and screenshots for you.
Add to Chrome, it’s freeHow do you fill in the user manual template?
- Write for one reader. Name who uses the product and what they already know; leave the rest out.
- List tasks, not menus. “Create an invoice” helps a reader; “The Invoices menu” does not.
- One action per step. Start with a verb and name the button exactly as the screen shows it.
- Put a screenshot where the reader could hesitate. Mark the button and crop to the area around it.
- Fill Troubleshooting from real questions. Take the last ten support requests and write the fix for each.
- Test it with a new user. Watch where they stop, fix that step, then set a review date.
For the full method see how to create a user guide for software.
What should a user manual include?
At minimum: who the manual is for, what the reader needs before starting, the tasks in the order a new user meets them, and what to do when something goes wrong. Settings, glossary and frequently asked questions are optional: drop a section rather than leave it half empty. Keep the version and date on the first page so readers can tell whether their copy is current.
User manual, SOP or work instruction: which one do I need?
A user manual teaches someone to use a product. An SOP describes how your organisation carries out a process from start to finish. A work instruction shows one task in detail. If you are documenting your own internal process rather than a product, start from the SOP template or the work instruction template.
How do you fill the task steps with Izly?
If the product is a web application, record the tasks instead of typing them. Start the Chrome extension and do each task once; every click becomes a numbered step with a marked screenshot. Edit the wording, hide personal data in the images, then paste the guide link into the manual or attach its PDF. Word export is on the paid plans. Izly records what happens in the browser, not desktop programs. Start free.
Frequently asked questions
Is the user manual template free?
Yes. Download the Word or PDF file or copy the text, and adapt it freely inside your organisation.
Can I use it in Google Docs?
Yes. Upload the Word file to Google Drive and open it with Google Docs; the headings and tables stay in place.
How long should a user manual be?
As long as the tasks need and no longer. A manual for a small tool can be five pages. If a task takes more than about ten steps, split it into two tasks.
Does a software manual need screenshots?
Not for every step, but they help wherever the reader has to find a button or a field. Mark the target and crop the image so it still reads on a small screen.
How often should I update the manual?
Whenever the screens change, and on a fixed review date, for example every six months. Record each change in the revision history.
Related pages
Record it once and let the guide write itself
With Izly you do the task once in the browser. Clicks and screenshots become a step-by-step guide that you edit, share, turn into a narrated video or run again for every row of a table.