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.
Robert Lauriston
>
> Bruce Combs original example was:
>
> "1. Select the Tx Inhibit check box, to block the operator from
> transmitting audio (optional)."
>
> To me, that "1." implies a linear series of steps. There's no branch,
> you check the box or not, then go on to step 2.
My problem with that instruction is that there's nothing telling me why I might want to do that, and what the implications are. Nine steps later, how much (how very, very, very much) am I going to regret having checked that box (or not checked that box), because I didn't understand one little implication that turns out to be crucial for how I need to use your system?
My solution, in my help, is to have a lot of expanding-text or drop-down-text boxes. If you think you know what you are doing, you can breeze through with just the minimal step-by-step instructions in view, all very visually uncluttered (except for some oddly colored words, here and there). But if you are the least bit unsure or even suspicious, you can click some of those teal-colored words and phrases and see what comes to light.
- Kevin
The 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.
Free Software Documentation Project Web Cast: Covers developing Table of
Contents, Context IDs, and Index, as well as Doc-To-Help
2009 tips, tricks, and best practices. http://www.doctohelp.com/SuperPages/Webcasts/
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
