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: Mac vs PC users From:Chris Morton <salt -dot- morton -at- gmail -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 6 Jul 2010 09:22:35 -0700
> 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.
I agree with Richard. As I recall, the best convention is to stick with a
single, standard methodoly throughout. Then add a Shortcuts page or section
that gives interested parties that information.
As for "File > Save" kind of operations, that belongs in a basic "How To Use
a <Mac/PC>" volume. I'd be inclined to not explain the procedure in detail
and (yes!) assume that the user has a basic understanding of the platform
he/she is using. You're righting an application guide, if I remember—not a
personal computer primer.
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-