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:3 ways to do one thing, slightly different From:Mary Choy <mchoy -at- SIRIUS -dot- COM> Date:Thu, 24 Jun 1999 16:36:00 -0700
I'm writing user docs for a product that has three ways to do just about
everything:
1. a button
2. a right-click menu option in a pane
3. a menu command
Each of the three ways generates a slightly different result. For example,
the button launches a wizard that guides you through how to do the thing.
The right-click menu option creates a dummy thing to be renamed and then you
have to do other things to complete the task. The menu command does yet
another slightly different variation on the theme.
Is it best to doc all three? My schooling is you only doc one way to do
things, not every tom-dick-harry way. But given that each way is slightly
(confusingly) different....
