Chapter 8
Writing User Manuals and More
IN THIS CHAPTER
Understanding the value of a well-written manual
Using styles and formatting
Preparing a step-action table
Knowing what sections to include in the manual
Determining frequently asked questions (FAQs)
Scripting an instructional video for streaming
Writing a simulated learning experience (SLE)
The central paradox of the machines that have made our lives so much brighter, quicker, longer and healthier is that they cannot teach us how to make the best use of them; the information revolution came without an instruction manual.
—PICO IYER, BRITISH AUTHOR
A user manual is also called technical documentation, an operational manual, user guide, instruction manual, quick start guide, training manual, maintenance manual, software manual, ...
Get Technical Writing For Dummies, 2nd Edition now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
