Re: conceptual material in procedures

Subject: Re: conceptual material in procedures
From: Lee Hunter <leeghunter -at- gmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 21 Apr 2005 10:11:16 -0400

On 4/21/05, Neumann, Eileen <ENeuman -at- franklintempleton -dot- ca> wrote:

> But there is also a lot of information on why the code is correct, and how the system is making decisions in the background.
> Because the material is for employees, and I'm talking about their jobs, I want to include this kind of conceptual information. However, I know that for procedures, you usually tell how, and don't burden the reader with why.

I would usually put conceptual information in a topic overview or
introduction which would be followed by the procedures. In the
procedures I'd try to include enough information to give them some
guidance or include a cross-reference. If there's a huge table I might
put it in an appendix chapter.

I'd be cautious about including information re how the system is
making decisions in the background. Only include this information if
the specific person performing the procedure *absolutely* needs it to
do their job.

Lee Hunter - Technical Editor & Information Architect

------ ------- 613-282-1904 ------


Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:

You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

conceptual material in procedures: From: Neumann, Eileen

Previous by Author: Re: Is Robohelp Going Away
Next by Author: Re: Release Note Formats
Previous by Thread: Re: conceptual material in procedures
Next by Thread: RE: conceptual material in procedures

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

Sponsored Ads