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.
Re: Documenting wizards that have numbered "steps"
Subject:Re: Documenting wizards that have numbered "steps" From:mandalynw -at- gmail -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 3 Jun 2005 11:21:30 -0600
I am on digest so apologies for the late-ish reply...
Assuming you *must* document the wizard, here is my preferred method for
handling wizards that fall somewhere in the middle of a larger procedure.
Simple and straighforward, and avoids the numbering conflict between the
procedure steps and the wizard steps. Put the wizard steps in a table. One
row for each wizard screen. Your table can have as many columns as
necessary, which in your case might be a Step column (for example, "Step
1"), a Title column ("Welcome to the Installation Wizard"), an Options
column ("Standard Install or Custom Install"), and an Action column
("Choose Standard Install and then click Next").
So the procedure would look something like this:
1. Start here.
2. Do this.
3. Do that. The Do Something wizard appears:
[ Step | Title | Options | Action ]
[ Step 1 | blah | blah | blah ]
[ Step 2 | blah | blah | blah ]
[ etc. ]
4. Do another thing.
5. Finish up.
New from Quadralay Corporation: WebWorks ePublisher Pro! Easily create
14 online formats, including 6 Help systems, in a project-based
workflow. Live, online demo! http://www.webworks.com/techwr-l
Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release. http://www.componentone.com/TECHWRL/DocToHelp2005
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.