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.
>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 second Lisa's suggestion: chunk the conceptual information into a
section separate from the procedure.
Do remember to consider what media you're presenting the info in and how
the users will use it when you do the chunking. This will affect how you
chunk. For example, you may want to put all the conceptual info into one
section, as Lisa did, or you may want to have task-based chapters that
contain one subsection on the concept and another subsection on the
procedure. You may also want to present tables with codes as job aids
(cards, printable one-page pdfs, or something similar) in addition to
presenting them in the text.
elizabeth
elizabeth -dot- oshea -at- virtualaccess -dot- com
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.
