Re: conceptual material in procedures

Subject: Re: conceptual material in procedures
From: Chris Anderson <chris -at- bizmanualz -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 21 Apr 2005 10:26:36 -0500

You can add it as an appendix, reference, or possible in line with the other text depending on the amount of the material. We do this all the time. It is the same as adding a work instruction to the procedure.

We also produce two seperate documents for the system. i.e. for ISO 9000 you have a quality manual and a set of procedures. We do the same with accounting and produce one accounting manual (like an ISO quality manual) and a set of accounting procedures, seperate from the accounting manual. Then you can add additional material to the accounting manual to include some of the why.
It all depends on the quantity of content you are talking about. I would not want to overload the procedures with too much content that distracts from the task at hand.

Chris Anderson, Managing Director 130 S. Bemiston Ave. Ste.101, St. Louis, MO 63105
Phone 314-863-5079 x11, Sales 1-800-466-9953,
Saving thousands of organizations, hundreds of thousands of dollars each year, by tuning their management systems to getting the right things done right.

Neumann, Eileen wrote:

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



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: What Can We Do?
Next by Author: Re: Documenting Hardware....yikes
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