Re: Dealing with required/optional information in the same doc

Subject: Re: Dealing with required/optional information in the same doc
From: Susan W. Gallagher <sgallagher5 -at- cox -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 3 Jun 2005 18:14:33 -0400


My recommendation is to keep your numbering scheme, but
lose the word "optional" as the steps really aren't. They're
required for one of the configurations, but not the other. So, to use your example...

Step 1: Backing Up Data (Configuration 1 only)
(first para for step 1 section is this note)
Note: this step is only required for configuration 1.
If you are installing configuration 2, proceed directly
to step 2.
Step 2: BIOS Config
Step 3: Installation
Step 4: Configuration
(last para for step 4 section is this note)
Note: If you are installing configuration 1, proceed
to the step 5. If you are installing configuration 2,
the installation process is now complete.
Step 5: Setting Up Replication (Configuration 1 only)
(first para for step 5 section is this note)
Note: this step is only required for configuration 1.
Do not perform this step if you are installing configuration 2.

HTH!
-Sue Gallagher

Victoria asks:
> Maybe it's just not enough coffee yet..I think it's an issue on how to handle numbering.
>
> ...we're working to combine procedures
> that used to be two highly redundant chapters...The problem I am having with
> series of steps that are only required for 1 of the 2 configurations.
>
> Sloppy Example:
>
> Backing Up Data
> Step 1: BIOS Config
> Step 2: Installation
> Step 3: Configuration
> Setting Up Replication
>
> They are all steps, but Backing Up Data and Setting Up Replication are
> only required for 1 of the 2 configurations...I don't want to get rid of the "Step"
> references, since we've gotten good user feedback...
>
> Do I give even the optional steps a step number and just note it (Step
> 1: Backing Up Data (Optional)). Do I just bite the bullet and manage
> two 30+ page chapters where only about 4 pages are different? (I'd love
> to have conditional or variable text right now but I don't, we use
> InDesign.)



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

New from Quadralay Corporation: WebWorks ePublisher Pro! Easily create
14 online formats, including 6 Help systems, in a project-based
workflow. Live, online demo! http://www.webworks.com/techwr-l

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: RE: How about including your location in your sig?
Next by Author: Re: Re: Does a rhetorical question need a '?'
Previous by Thread: Re: Dealing with required/optional information in the same doc
Next by Thread: Browser Specific Shortcut


What this post helpful? Share it with friends and colleagues:


Sponsored Ads