Re: Documenting Wizards

Subject: Re: Documenting Wizards
From: Goober Writer <gooberwriter -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 14 May 2003 05:39:09 -0700 (PDT)

> I have a question about documenting wizards. The
> product is a web-based application with online help.
> Should I include the documentation for the wizard
> steps in the docs or just put the content on each
> screen/step of the wizard.

I tend to lightly touch on using wizards in the docs
and supply help content and text string enhancements
for the UI itself. After all, a wizard is there to
simplify a task. Open it, plug your settings, and
done. By clarifying the controls in the UI itself and
supplying online help for more complex features of the
wizard, you'll benefit the user. I haven't seen too
many examples of people documenting wizards heavily in
the docs, primarily because a wizard is there to help
the user complete a task the "easy way".

Goober Writer
(because life is too short to be inept)

Do you Yahoo!?
The New Yahoo! Search - Faster. Easier. Bingo.


Robohelp X3, from eHelp, lets you quickly and easily create
professional Help systems for all your Windows and Web-based
applications, including Net.

Order RoboHelp X3 in May and receive a $100 mail-in rebate, PLUS
free RoboScreenCapture and WebHelp Merge Module.

Order RoboHelp today:

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


Documenting Wizards: From: Wade Courtney

Previous by Author: Re: Page count a list of Word documents
Next by Author: Re: Documentation Manager: does it always include managing a team?
Previous by Thread: Documenting Wizards
Next by Thread: Re: Documenting Wizards

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

Sponsored Ads