conceptual material in procedures

Subject: conceptual material in procedures
From: "Neumann, Eileen" <ENeuman -at- franklintempleton -dot- ca>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 21 Apr 2005 09:58:58 -0400

Hello Whirlers,

I'm writing a user guide for employees of a financial company. The guide explains how to perform a particular transaction. There are two aspects - the how to, i.e., how to use the database, and a large conceptual component. This is knowledge that you don't necessarily need to perform this task, but that explains why you do some actions. An example is why you choose code T as opposed to code C. I can give a table that explains what code to put in what situation. 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.

Has anyone run into this, and if so, how did you handle it? (A separate manual is not an option-management wants one manual.)


Eileen Neumann
Business Rules and Procedures


Notice: All email and instant messages (including attachments) sent to
or from Franklin Templeton Investments (FTI) personnel may be retained,
monitored and/or reviewed by FTI and its agents, or authorized
law enforcement personnel, without further notice or consent.


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.


Previous by Author: RE: Industry size Technical Documentation
Next by Author: RE: conceptual material in procedures
Previous by Thread: Tools: Missing PC symbols on a Mac? Use your browser!
Next by Thread: Re: conceptual material in procedures

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

Sponsored Ads