Skip to main content
How Can We Help?
This is technical documentation covering the software’s ui dialogs, settings, configurations, and parameters.
Common types of quick-reference guides
Learn your audience’s needs and expectations and then create the content they need to succeed.
- Quick-start guide
Help your users get up and running quickly with your product.
- Core or basic task guides
Similar to a quick-start guide, but offers an overview of how to use your product or service’s most basic or core features.
- Guide to more advanced features
Once your users are ready to take things to a new level, use a quick-reference guide to introduce them to other functionality or features.
- Guide to product changes
Did your software recently update? Use a quick-reference guide to walk your users through the changes.
- Step-by-step how-to
Got a process you need to explain? Show it!
- User manual for products with limited features or functionality
If your product doesn’t require a huge manual, a quick-reference guide may be all the documentation you need.
