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.
------------------------------
Claire asked
Should I document this sub-procedure fully for the first instance only and cross-reference the user to this section for all other elements.
Or
Should I include the procedure in full every time it is required. I have already placed procedures that are identical for all elements at the beginning of the chapter and cross-referenced to that.
------------------------------
Is it electronic or print or other?
If it's electronic, I'd use cross-references like this.
1. Complete this step. (Click here for instructions on completing this step)
2. Paint the wangdoodle.
3. Click Save.
In our online help, we have a step that instructs the user to load a record in most of our how-tos. The step includes a link to a complete how-to that explains how to load records.
If it's print, I can see arguements for both of the options you asked about.......mmmmmmm. I suppose if the steps are exactly the same, then having a core set of steps separate from the others (with a cross-reference) would be fine. That way your users can start to internalize at least some of the steps and start to see how the product functions in similiar ways. mmmmmmm Yeah.
********************************************
"And in the morning, I'm makin waffles." ~ Donkey
Sean Hower - tech writer http://hokum.freehomepage.com
_____________________________________________________________
Create your own web site for FREE at http://www.freehomepage.com
_____________________________________________________________
Select your own custom email address for FREE! Get you -at- yourchoice -dot- com w/No Ads, 6MB, POP & more! http://www.everyone.net/selectmail?campaign=tag
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!
Order RoboHelp X3 in November and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l
---
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.
