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.
Tim Murray very sensibly said:
> > I"m writing some Help for a MAC application, and a lot of
> the feedback I get is, EVERYONE knows this - you don't have
> to explain it (such as what happens when I click File > Save,
> or what an Action button is, etc.
> The issues are the same, it's just that the actions to
> perform a task seem to be easier to grasp on a Mac than in
> Windows. (And it's Mac, not MAC. Mac is an abbreviation, not
> an acronym or initialism.)
> In other words, if someone doesn't know anything about the
> concept of saving files, then they'll need more information.
> But unless you're writing about their very first app, I'd say
> just "save the file."
If there's any doubt as to the naiveté/sophistication of the
audience, make "save the file" an expanding text link.
If you are concerned that such basic stuff behind some
expanding text links will put off more sophisticated users...
who might then avoid opening all expanding text (including
some that might do 'em good), then develop a color code or
other typographical convention for the links, to distinguish
"EVERYONE knows this" from "here's some sophisticated background
to the gnarly content on this page".
- KevinThe information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.
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-