User Manual
User manual example including FAQ, onboarding, troubleshooting and user guides.
YouDoCMS is a fast and simple static site generator that is ideal for building project documentation of any kind. Documentation is written using the TinyMCE HTML editor so no need to learn markdown. Start by reading the Getting Started, then check the User Guide for more information.
Frequently Asked Questions
FAQ page is a non-exhaustive list of common questions and answers relating to the user manual. Its primary purpose is to enable self-service for you customers and users.
Onboarding Guide
The onboarding guide (operating manual, instruction manual) topics covered are as follows: Installation and integration; Getting started and user login; Example use cases and features; Customisation; Import, Export, Reporting of data; Help and documentation; Contacts, support and self-service platform.
User Guide
Audience and scope; What it does i.e. a functional description; How to use the product in the intended way; Where the product can be used; Who can use the product i.e. qualifications required; Dependencies i.e. other product requirements; Standards and compliance.
Maintenance Warranty and Repair
Maintenance schedule; Safe disposal; How to repair the product; Who can repair; Skills and tools required; Replacement of parts; If required add an appendix listing accessories, consumables and spare parts; Warranty terms and conditions.
Troubleshooting
A troubleshooting guide helps the user with a specific problem solve the issue or perform a workaround. This includes a description, the cause including a typical use case to repeat the problem, a description of the solution with step-by-step instructions and lastly references to related documentation in a knowledge base, user, product or operating manual.