Introduction
Almost every manual has this part where you give your users
- a quick overview of the product.
It could also include
- A picture of the product specifying its primary purpose, characteristics, or even requirements for its setup or assembly.
This heading is often used interchangeably or merged with titles like “Overview” and “Preface” and includes
- a brief introduction to the user manual (about this manual)
- and the intended users as well.
They could contain information like
- what this manual covers,
- what conventions have you used in the manual,
- who you wrote the manual for
- and who could use this manual
You could use the convention guide table at the beginning of this template as a pattern to create your conventions. You could also add caution and warning symbols/styles to this table.
| Symbol/Style | Meaning |
|---|---|
| ★ Blue box with a star symbol | Important notes |
| 🛑 Pink box with a caution symbol | Cautions |
| ⚠ Pink box with a warning symbol | Warnings |
| ❗ Red box with a danger symbol | Dangers |
| 💡 Green box with an idea symbol | Examples |
| → Purple box with an arrow symbol | Extra information |