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:Hemanth Basrur <hemanthbasrur -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 2 Jun 2005 00:12:33 -0700 (PDT)
Hi,
Before I could answer your question, I would like to
know if the developers have provided a help button for
each screen in the wizard as the user clicks the Next
button.
If your answer is yes, then you can capture the use
and pre-requisites of the wizard for the first
introduction screen of the wizard and for the
subsequent screens, write context sensitive help. For
example, when I launch the wizard, I may click on the
Help to see the use and pre-requisites for running the
wizard. When I click on the Next button and am on Step
1 screen, I would like to see the help information
pertaining to Step 1 only and so on.
If your answer is No and you want to provide one help
file, which covers the whole procedure, you can write
the help file, which captures
* Use of the procedure
* Pre-requisites for executing the procedure
* Procedure (Steps)
* Result of the procedure
in that order.
Hope this helps.
Regards,
Hemanth
__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around http://mail.yahoo.com
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.