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.
If most of the steps differ for the two systems, I would write two separate
procedures, each under the appropriate heading.
If most of the steps are the same, I would use a format similar to the
following:
1. On the Optional Components screen:
* For a Windows 95 system.....
a. Click the Doohickey button
b. Choose the Aunt Freddie option
* For a Windows 2000 system
a. Click the Renamed For No Reason button
b. Choose either the Thingummy or the Whosit option, depending on
the barometric pressure
2. Proceed with next instruction ...
To me, this makes it clearer that you do one or the other procedures under step
one, but not both. If you use 1. For Win95... and 2. For Win2000..., it makes it
appear as if those are sequential steps. If you keep them both within the same
step but don't break them out as bulleted items or indented paragraphs or make
some other visual distinction, again it's not as clear that part of the step is
making a choice based on the system you're using. "Do the following,
depending..." doesn't tell me what I'm either using or trying to accomplish, as
does "On the Optional Components screen..."
Jo
--
Jo Baer
Senior Technical Writer
TCF National Bank
Minneapolis, Minnesota
jbaer -at- mailbox1 -dot- tcfbank -dot- com
If you can remain calm, you
just don't have all the facts.
Loraine Nazareth wrote:
> Hi,
> What's the best way to present procedural information where instructions
> depend on the type of software you are using?
>
> Example:
>
> 1. For a Windows 95 system: On the Optional Components screen,...
>
> 2. For a Windows 2000 system: On the Optional Components screen,...
>
> OR
>
> 1. For a Windows 95 system: On the Optional Components screen,...
> For a Windows 2000 system: On the Optional Components screen,...
>
> OR
>
> 1. Do the following, depending on the system you are using:
>
> For a Windows 95 system: On the Optional Components screen,...
> For a Windows 2000 system: On the Optional Components screen,...
>
> 2. ...
>
> Other suggestions?
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
Learn about tools and technologies for user assistance developers at
The Help Technology Conference, August 21-24 in Boston, MA
Details and online registration at http://www.SolutionsEvents.com
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.