TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
> 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. http://search.yahoo.com
---
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 http://www.raycomm.com/techwhirl/ for more resources and info.
