About This Template
This template covers a professional user manual's standard components and headings, primarily targeting on-premise software products. The present template provides instructions for authors for each section, boilerplates, and real examples to help you with the content you need to include under each heading. Remove all author's guides, extra explanations, and titles that are not applicable.
Take note of the conventions used in this template:
| Symbol/Style | Meaning |
|---|---|
| <Text in chevrons> | To be replaced by the relevant information |
| [text in brackets] | Optional |
| Words before and after a slash/ | Alternatives |
| {text in curly brackets} | Boilerplates |
| Bold text | Main items or summaries of a section |
and
| Main items or summaries of a section |
Here is a clarification of symbols and their meanings used in Sonat's template boxes:
| 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 |