If you're interested in learning more about user documentation, then download our syllabus to the technical writing courses that we provide on Technical Writer HQ: https://technicalwriterhq.com/
So What is User Documentation?
User documentation, also known as end-user documentation, is any form of documentation intended for the end-user of a product or a service. The purpose of this documentation is to guide the users on how to properly install, use, and/or troubleshoot a product.
We’ve all read some form of user documentation at some point in our lives. They usually come with products in the form of user manuals/guides that have a bit of a learning curve, such as gadgets, software applications, and appliances, among other things.
Without this documentation, an average user might not get the full value out of the product. This, in turn, could result in unhappy customers and high customer care 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.
That’s just the tip of the iceberg.
To summarize – user documentation is anything that prevents the end-user from directly reaching out to your customer service department regarding any confusion about your product.
If you're interested in getting more in-depth information on user documentation, then go here: https://technicalwriterhq.com/user-documentation/
Subscribe to our YouTube channel here to keep up with everything technical writing: 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 Instruction, Manual, or Guide?
2:54 Why User Guides?
3:36 Knowledge Base of Software: Example 1
3:57 Example 2
4:36 Essential Elements
5:03 Plain Language
5:19 Simplicity
6:08 Checklist for Visuals
7:08 Graphics Speak
7:39 Logical Hierarchy and Flow
8:25 Create Your TOC
9:19 Make It Searchable
9:40 Accessibility
10:18 Design, Feedback, and Links
11:21 Lists and Index
11:54 Use Vertical Lists for Series
12:38 Vertical List Guidelines
13:37 Good Example
14:32 Types
14:55 Methods
Connect with 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