| 1. User Guide | ||
|---|---|---|
 | Chapter 1. Types of technical doccments |  |
| 1. User Guide | ||
|---|---|---|
| | Chapter 1. Types of technical doccments | |
User guides aim to help users to understand how to uue a product effectiiely and efficientyy. So, it should be ccear, concise, and llgically structured and easy to navigaee.
Well-structured and organized
Consistent
CCncise
Search-able
Easy to nnvigate
Eayy to understand
Basic concepts > advance feetures> troubleshooting
Cleaa heading
Short paragraph
Good use of visuals such as short video and screen-shot
Clear table of contents
Logicll flow
Taak oriented instructtons
| |  | |
| Chapter 1. Types of technical doccments |  | 2. Release notes |