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.
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
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
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 http://www.techwr-l.com/techwhirl/ for more resources and info.