If you need to create user documentation for any products, this is the class for you. There is still time to sign up.
6 weeks of learning how to deliver what your users need, on time and in budget. And, as an added benefit, good user assistance reduces customer support costs and product returns. You really can’t afford to not take this class.
To learn more and sign up, go here.
I’m not a strong visual learner. I like words and getting my hands on things. But many people are strong visual learners and I need to accommodate them in any content I develop. So, since I like words, I found a book that helps me with visual information. I thought I’d share some highlights with you in case you’re also not a strong visual learner.
By the way, to find out your learning strengths, take the VARK quiz.
The book is a classic: William Horton’s Illustrating Computer Documentation. Wiley Press, 1991.
I realize it’s older but the concepts and principles are valid regardless of when it was written. If it’s not on your shelf, I strongly recommend you get it. Mine is dog eared and written in and tagged all over.
Design content for scanning
Since I like words so much, I was delighted to discover that words can be graphical elements, too. Lists and tables are visual and need to be designed as such to support your visual learners.
While tables are inherently a grid, you can make tables harder to read by using horizontal AND vertical lines. Pick one (and you may not even need that) that suits the information and stay with that. Make any lines thin enough to let the eye follow but not thick enough to visually draw the eye.
Since humans are hard wired (because of the rods and cones in our eyes) to see lines, we want the thickness of the line to not overwhelm the visual field.
Lists are always a good thing to use. If you use lists, make sure they are used correctly.
Organizing content visually
Screen captures are good and we all use them, assuming you’re developing content for software. But think about how else you can visually show information.
For example, the last time I was documentation manager, I instituted a policy that every chapter (section) must have an introductory paragraph(s) and then a graphic that illustrated the ideas in the paragraph(s). This supported both our word learners and our visual learners. It visually organized the content in that section.
Typically, we had a flowchart, showing information flow through the system but sometimes we showed how parts worked together. It depended on the content in that section. We single-sourced that graphic to the online help to support the different learners there as well. Had we the time and the staff, the graphics might have become animations online.
The Annual Lavacon conference on Digital Media and Content Strategies is in Austin TX this year and I’ll be there.
Presentation
I’ll be presenting on The Top 10 Mistakes Companies Make when Moving to Topic-Based Authoring. This topic will show you the top 10 mistakes people make when moving to topic-based authoring. About the presentation:
Topic-based authoring is the most cost-effective way to develop content in the “Do more with less” world we live in. It can also help you better meet the needs of your users. It’s a potential win/win for your company and your users. Makes you want to jump right in, doesn’t it?
Workshop
I’m co-leading the workshop Critical Project Management Skills for Content Developers and Documentation Managers. If you feel you’re not managing your projects well or want to enhance your skills, this workshop will help. About the workshop:
As professionals in our field, we often think we think we can just focus on developing content or managing staff. But in reality, we must manage our projects to get the right result in the right time frame. But who has time to get certified in project management? You need the skills right now.
To sign up for Lavacon, go to Lavacon.org. See you in November!
