If you want to learn more about user documentation, download our curriculum for the technical writing courses we offer on Technical Writer HQ: https://technicalwriterhq.com/

So what is user documentation?

User documentation, also called end-user documentation, is any form of documentation intended for the end user of a product or service. The purpose of this documentation is to provide users with instructions on how to properly install, use, and/or troubleshoot a product.

We have all read user documentation at some point in our lives. It is usually included in the form of user manuals/instructions for products that require a certain learning curve, such as gadgets, software applications, and home appliances.

Without this documentation, an average user may not be able to get the full benefit of the product. This, in turn, can lead to dissatisfied customers and high customer service costs and churn rates.

What's more, user documentation comes in all shapes and sizes. It doesn't necessarily have to be in physical paper form. It can also be a PDF file, an infographic, or even a collection of web pages with helpful resources.

This is just the tip of the iceberg.

In summary, user documentation is anything that prevents the end user from contacting your customer service department directly when they are unclear about your product.

If you are interested in more detailed information about the user documentation, go here: https://technicalwriterhq.com/user-documentation/

Subscribe to our YouTube channel here to stay updated on all tech topics: https://bit.ly/3snITet

Want to connect with other technical writers? Join our exclusive community of technical writers here: https://bit.ly/twhq-community

0:00 Introduction
0:29 User documentation?
2:04 User manual, manual or instructions?
2:54 Why user manuals?
3:36 Software Knowledge Base: Example 1
3:57 Example 2
4:36 Essential elements
5:03 Simple language
5:19 Simplicity
6:08 Checklist for visuals
7:08 Graphics speak
7:39 Logical hierarchy and flow
8:25 Create your table of contents
9:19 Make it searchable
9:40 Accessibility
10:18 Design, feedback and links
11:21 Lists and index
11:54 Using vertical lists for series
12:38 Guidelines for vertical lists
13:37 Good example
14:32 Types
14:55 Methods

Contact me here:
LinkedIn: https://www.linkedin.com/in/joshua-fechter/
Twitter: https://twitter.com/joshfechter5
Instagram: https://www.instagram.com/joshua.fechter/

#UserDocumentation #UserDocuments #JoshFechter

Please take the opportunity to connect with your friends and family and share this video with them if you find it useful.