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.
Thank you so much for your input. You provided some excellent ideas, special thanks to Peter Hirons, Mike Bradley and Paul Strasser.
What I have decided to do is include the full sub-procedure within the key element where it is always necessary. In this procedure I have provided easy access to the detailed background required to choose the correct alternatives within the procedure.
In the other four places where the procedure is used I have included a pared down (almost quick reference) version of the procedure and a cross reference for more details.
My reasoning is as follows:
As these procedures will not be performed on a regular basis, perhaps once or twice every few months, the user may need a reminder of how to perform the procedure (hence the quick reference), and if a lot of time has passed may need a full revision of the rationale (hence the link to detailed info.). It makes for a heavier manual but I think will meet the audience's needs more accurately.
Once again, thank you for your help.
Claire
Documentation Manager
EDAMS Technology Ltd
Office: +357 22 478300
Website: www.edams.com
_______________________________________________________________
This email is confidential and intended exclusively for the use of the individual to whom it is addressed. Any views or opinions presented are solely those of the author and do not necessarily represent those of EDAMS Technology Ltd.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
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!
---
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.
