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.
Subject:Re: conceptual material in procedures From:"Lisa M. Bronson" <lisa -at- techwr-l -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 21 Apr 2005 08:08:49 -0600 (MDT)
Hi Eileen,
I had this situation come up a few years ago with a manual about
ultrasonic welding. There was a lot of theory of operation information
scattered throughout the previous version of the manual, often
interrupting procedures. Our service techs and customers definitely
complained about it. When I wrote the new version of the manual, I created
an "Introduction" section (chapter), put all the conceptual information in
that, and referred it from other sections of the manual. This type of
section gives the readers what they need without cluttering up the actual
procedural information.
I hope you will find this helpful!
Lisa B.
> 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.)
>
> Thanks,
>
> Eileen Neumann
> Business Rules and Procedures
>
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.
