[Author Prev][Author Next][Thread Prev][Thread Next]
[Author Index (this month)][Thread Index (this month)][Top of Archive]

Re: Repetition in Procedures

Subject: Re: Repetition in Procedures
From: Anthony Davey <ant -at- ant-davey -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Sun, 24 Nov 2002 11:17:24 +0000


Claire,

Given that the sub-procedure is: a) long, and b) included in virtually every other procedure, I would be inclined to document it only once.

The result will be a smaller, less daunting manual. I'd almost be inclined to document it separately from all the procedures and cross-reference it in every instance. If your audience is going to be using this sub-procedure quite frequently you could introduce it as such and they may then learn most of by heart (even if only through repetition), or at least remeber where it is to be found within the manual as a whole.

Regards,
Ant

Claire Philpott wrote:

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.






^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.

References:
Repetition in Procedures: From: Claire Philpott

Previous by Author: Re: Documenting for the non-typical user? WAS: Fields arranged as a sentence
Next by Author: Re: ID or Id?
Previous by Thread: Re: Repetition in Procedures
Next by Thread: Re: Repetition in Procedures

[Top of Archive] | [Author Index (this month)] | [Thread Index (this month)]

What this post helpful? Share it with friends and colleagues:

Sponsored Ads