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.
Subject:Re: Repetition in Procedures From:peter -at- softwell -dot- co -dot- uk (Peter Hirons) To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Sun, 24 Nov 2002 10:25 +0000 (GMT Standard Time)
> 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.
>
Here's my thoughts:
If the sub-procedure is the end of the larger procedure then put in one
place and refer. (If you're going to refer to the sub-procedure from a
number of places then add it to the common material at the beginning of
the chapter rather than include it in the first use.)
If the sub-procedure is the middle of the larger procedure then repeat at
each place. Users will not want to find another page in the manual then
have to return to the previous place (which they've probably forgotten).
This, of course, depend on how many times you use the sub-proc and its
size - you may just want to save paper!
Peter
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
