TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Documenting A Ballet Dance From:Jenn Wilson <jenn -at- mylar -dot- outflux -dot- net> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 13 Dec 2005 11:29:48 -0800 (PST)
I am reminded of a vexing example...
My partner has been collecting Legos since he was a kid. The instruction
booklets usually rely solely on series of diagrams; this fits well into
the goal to support users of different primary languages and literacy
levels.
The trouble is that the diagram-only philosophy doesn't always cut it, in
terms of what I consider "good documentation" in professional circles.
Complex builds with weird pieces can get darned confusing, and rotating
the view can just make a step harder to follow. It makes me fussy and
self-conscious!
On the one hand, that bit of challenge might be part of the point for an
"educational toy." On the other, I can't imagine applying that principle
in software docs for my current audience, who use my manuals precisely
_because_ they don't want to play with the software and figure it out.
Anyway -- in moments of whimsy, I've wondered whether Legos could provide
a basis for a decent tech-comm test, in the right context. :)
Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005