Re: conceptual material in procedures

Subject: Re: conceptual material in procedures
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 21 Apr 2005 08:02:04 -0700


Many times. Engineers just love to stuff background information
into their input, and sometimes - just *sometimes* - it's something
the intended reader, whether user or service provider, can actually
use.

Depending on the particular environment, I have provided separate
"theory of operations/functional description" chapters or appendices,
and have on occaision also used sidebars running alongside the
actual procedures to provide additional information that relates
directly to a procedure. One of my favorites was a case where
the end users would be decidedly non-technical readers. We put
the background info into sidebars next to the procedure steps, and
titled the sidebars "Why am I doing this?"

Gene Kim-Eng


----- Original Message -----
From: "Neumann, Eileen" <ENeuman -at- franklintempleton -dot- ca>


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




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.



Follow-Ups:

References:
conceptual material in procedures: From: Neumann, Eileen

Previous by Author: Re: Definition of "User-Friendly" Was Re: Engineering design practice
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


Sponsored Ads