How do I create an awesome user manual and training series?
April 26, 2014 3:55 PM Subscribe
As part of my job, I've been tasked with developing a user guide for an open source software package that my company developed, as well as future webinar (and possibly in-person) training materials. Is there a good source for finding industry best practices for user manuals and tutorials? I'd like to see what the most innovative organizations are doing when it comes to training materials.
posted by JuliaKM to Education (6 answers total) 23 users marked this as a favorite
Google has led me to the Society for Technical Communication and http://www.instructionaldesign.org/ but I am having trouble finding specific examples and detailed best practice guidelines.
I could use help identifying:
- Different ways to organize information in a manual. For example, should I start with very basic instructions and then build complexity with each chapter?
- Best practices for creating webinars that don't put people to sleep.
- How to plan long-term for also creating more detailed developer documentation.
Two books that look promising are Design For How People Learn
and Essentials of Online Course Design: A Standards-Based Guide
. However, I wanted to check with the wise people of Metafilter before embarking on an Amazon spending spree. Would you recommend either or these books or other ones? What other resources should I be checking out?
Thanks in advance!