Documenting wizards?

Subject: Documenting wizards?
From: "Hart, Geoff" <Geoff-H -at- MTL -dot- FERIC -dot- CA>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 14 May 2003 08:28:20 -0400

Wade Courtney wonders 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.>>

The whole raison d'etre for a wizard is to avoid the necessity for
explaining a task in online help or other documentation. Thus, mention the
existence of the wizard in your documentation, but if any screen of the
wizard seems to require its own documentation, consider it a failure and
redesign it until it no longer needs additional explanation. All
documentation for a wizard should be embedded in the wizard itself.

--Geoff Hart, geoff-h -at- mtl -dot- feric -dot- ca
Forest Engineering Research Institute of Canada
580 boul. St-Jean
Pointe-Claire, Que., H9R 3J9 Canada

"It's one thing to see death coming at the hands of your own creation.
That's part of the human epic tradition, after all. Oedipus and his father.
Baron Frankenstein and his monster. William Henry Gates and Windows
'09."--David Brin, _Kiln People_


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.


Previous by Author: Basing Word styles on Normal or Body Text?
Next by Author: Documenting wizards? (take II)
Previous by Thread: Antwort: Re: English isn't the native tongue of ...
Next by Thread: Re: Documenting wizards?

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

Sponsored Ads