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: Multiple ways of doing things From:Dan 'Fergus' Roberts <droberts -at- PANIX -dot- COM> Date:Fri, 18 Aug 1995 06:38:04 -0400
David and Susan Suna (suna -at- cnct -dot- com) wrote:
: 1. List all methods with examples.
: 2. List only one method
: 3. List one method as the primary method with a note
: I tried option 1 but it seems wordy and repetitive as some of the
: steps are common between the different methods.
Option 1 is probably overkill, if some of the steps are the same.
Option 3 might be the best, if you provide enough detail on the steps that
are different, and compress the steps that are the same <the "Do this step,
as described above" kind of thing>. Or perhaps some of the steps in the
alternative methods are discussed more thoroughly in another place - perhaps
you might reference the reader to that place for a more in depth discussion.
--
-----
Dan 'Fergus' Roberts
droberts -at- panix -dot- com
-----
