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.
-------------------------------------
Andrew T. Brooke asks:
what do you find is the best approach to document very complex tasks, tasks in which one or more previous tasks must be completed before the final task can be done?
-------------------------------------
I usually present each task in an overall process as a step, with a link to specific instructions on completing each task. The following is an example:
GOING TO THE RESTARAUNT
1. Make reservations. Click here for instructions on making reservations.
2. Drive to the restaraunt. Click here for instructions on driving to the restaraunt.
3. Park. Click here for instructions on parking.
4. Yada yada. Click here for isntructions on yada-yada-ing.
and so forth.
I don't use the "Click here" sentence, I either make a keyword the link, or (if I'm creating help for my current job) put the link in what we call a Details popup. Either way, the macro process is presented as a single task, with links to each sub-task.
"Whatever you do, do NOT let your editorial decisions be made by the squiggly spell-checking lines in Word!" ~Keith Cronin, Techwr-l irritant ;-)
_____________________________________________________________
Create your own web site for FREE at http://www.freehomepage.com
_____________________________________________________________
Promote your group and strengthen ties to your members with email -at- yourgroup -dot- org by Everyone.net http://www.everyone.net/?btn=tag
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out the new release of RoboDemo, our easy-to-use tutorial software.
Plus, buy RoboHelp Office in August and save $100 with our mail-in rebate.
Get details and download free trial versions at http://www.ehelp.com/techwr-l
Acrobat & FrameMaker Seminars: PDF Best Practices, FrameMaker-to-Acrobat
Advanced Techniques, FM Template Design, Single Sourcing with FrameMaker
in Brussels (Oct), and in Montreal & Dallas (Dec): http://www.microtype.com/1
---
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.
