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.
I'm having a Friday afternoon at the end of a long week quandary. Please help.
I am writing a manual for an engineering audience. This manual describes how to add complex elements to a data model. A user may want to add in one session all the different types of elements, or may want to add only one specific type.
I am including a procedure for every element. Now here's the problem. Within a number of these elements there is a lengthy sub-procedure which is identical.
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.
Any advice?
Thanks
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.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
