TechWhirl Sponsors

---

 

[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: DaveC <peninsula -at- covad -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 26 Nov 2002 10:47:08 -0800

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.

Include the sub-procedure description once, in full, in each major procedure. If/when it is required subsequently in each major procedure, reference its earlier use.

No one likes to have to look up the sub procedure, marking current pages to come back to. A royal pain.

Dave


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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: Hackos' minimalism seminar -- some insights
Next by Author: RE: STC and words
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)]

---

---

---