Documenting wizards that have numbered "steps"

Subject: Documenting wizards that have numbered "steps"
From: l_migliorini -at- yahoo -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 1 Jun 2005 10:36:09 -0600

I am curious to know how others handle the following situation.

I have to document a wizard that has numbered steps - that is, the words
"Step 1 Step 2, Step 3," etc. appear right on the dialog and as part of
the name of that tab.

But of course, in the procedure I am writing, there are a few steps that
you must take before you even get to the wizard Step 1, so the "steps"
will always be out of synch.

I thought of having the main procedural steps and then treating the whole
wizard as just one step. That way the discrepancy between "my" numbers and
the "wizard's" numbers would not be so great:

1. go to such and such and log on
2. navigate to such and such and change your options
3. change the path names and do blah blah
4. Use the Wizard.
a. Step 1
b. Step 2
c. Step 3
d. and so on.
5. do the next step of the main procedure once done with the wizard
6. save and close and so on.

What do the others think?


New from Quadralay Corporation: WebWorks ePublisher Pro!
Completely XML-based online publishing. Easily create 14 online formats, including 6 Help systems, in a streamlined project-based workflow. Word version ships in June, FrameMaker version ships in July. Sign up for a live, online demo!

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.

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 for more resources and info.

Previous by Author: Re: "Zooming" in on screen shot
Next by Author: Re: Documenting wizards that have numbered "steps"
Previous by Thread: Re: "Zooming" in on screen shot
Next by Thread: RE: Documenting wizards that have numbered "steps"

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

Sponsored Ads