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.
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_
---
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.
