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.
> From my perspective, it is terribly confusing to have up to 4-key
> combinations for keyboard shortcuts, AND to have as many as three or four
> different ways to do the same thing.
> I am writing so many instructions about those FOUR methods it's driving me
> nuts! As a user, I get confused when there are too many ways to do the same
> thing. I asked what the preferred method was, and answer:
> "Everyone is different, we know x is not done much, but someone might
> complain if we take it out, and we put y in because someone else
> complained, and of course we have to have Z because that is the MAC way of
> doing it..."
Does the person who's telling you this have the authority to make it stick? If not, I'd politely thank him or her and say, "If Z is the 'Mac way,' then that's the one I'll describe."
Documenting all the different ways of accomplishing the same task is a very bad idea, IMHO. And I believe you'll find plenty of tech writing resources that back me up.
If your procedures are full of steps that begin "Do one of the following," followed by a bullet list, just to tell readers how to select a menu item, it's both confusing and tedious. I think most users will quickly tire of this and give up on the help. I know I would.
Richard G. Combs
Senior Technical Writer
richardDOTcombs AT polycomDOTcom
rgcombs AT gmailDOTcom
Gain access to everything you need to create and publish information
through multiple channels. Your choice of authoring (and import)
formats with virtually any output. Try Doc-To-Help free for 30-days. http://www.doctohelp.com/
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-