Here are some tips on how to create great end user documentation with accompanying examples from companies who are doing it right shared in this article.
The goal of your end user documentation is to reduce the number of hours you spend explaining workflows, and reduce the number of hours end users spend looking for answers.
If you can remove hurdles your end users have to jump over in order to find answers, they will reference your documentation. And that will create self-sufficient end users who do the job correctly, in less time, and without constantly involving you.
Here are some of the topics covered:
- Write great titles
- Use annotated screenshots
- Use video, screenshots and text
- Include links to related articles
- Easy to browse
- Easy to search
- Easy to find
- Show the end result
- Show the steps and substeps
- Unique URLs for each article
Some of the companies used in the examples are Hubspot, Skuid and Metric Insights.
To learn more about how to make good documentation check out the full article here.
Also published on Medium.