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:Two Paths to the same function From:Kyle Kimberlin <Kyle -at- di -dot- com> To:"'TechWr List Post Msg'" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 15 Sep 1999 15:08:47 -0700
Amy, I think the manager's preference, and the model you gave to effectuate it,
are customary. My opinion is to give the reader both options together. In
fact, I wonder if most readers would want a "shortcut column" at all. It makes
good sense to the writer, but forces the reader to keep looking back and forth.
That's something to think about.
> ----------
> From: Amy Lattof
>
> What do you do when the software you are documenting has two paths for most
> of its tasks? ...
>
> I've been dealing with them by documenting the "formal" menu way in the main
> procedure, and then giving the quick "button" way in my shortcuts column ...
> but my manager wants to document both paths in the main procedure. ...
>
> Select Tools > Run > MyApp from the menu bar, or click the MyApp button on
> the toolbar.
> And then the button way would also still in the shortcuts column.
>
> What do you think? Is my original scheme effective? Is his suggestion
> confusing (I think it would be...) Am I really off the wall here? Any
> comments or suggestions are welcome.
>
> TIA,
> Amy
~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~
Kyle Kimberlin
Technical Writer
Digital Instruments
Kyle -at- di -dot- com
~~~~~~~~~~~~~~~~~~~~~~~~
