RE: Documenting a wizard-based task

Subject: RE: Documenting a wizard-based task
From: "walden miller" <wmiller -at- vidiom -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 4 May 2001 08:51:20 -0600

> If the wizard needs documenting, maybe you should
> be reviewing the UI of the wizard -- ?
> Or are we not talking about the same kind of wizards?

All wizards are not created equal.

I am documenting a set of wizards that work in Visual Studio to build
skeletons of interactive TV code modules. The choices you make are obvious
if you already know how to build one of these code modules, but need a lot
of explanation if you don't have experience. The wizard saves a lot of
time, any both cases, but docs are very necessary.

My suggestion for documenting a wizard is two-fold: create a GUI reference
that explains all choices found in the wizard (screen by screen) and then
create a set of procedures that use the (you choose) top 3, 4, 5, decision
paths and call it a day. You document the main uses procedurally, and you
provide an exhaustive reference for the advanced decisions.




*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at or info -at- devahelp -dot- com

Sponsored by Information Mapping, Inc., a professional services firm
specializing in Knowledge Management and e-content solutions. See or 800-463-6627 for more about our solutions.

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.

Re: Documenting a wizard-based task: From: John Cornellier

Previous by Author: RE: tool nonsense (gearing up to be a tech writer)
Next by Author: RE: Designing packaging matter??
Previous by Thread: Re: Documenting a wizard-based task
Next by Thread: RE: Documenting a wizard-based task

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

Sponsored Ads