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: How to approach this task? From:Tony Markos <ajmarkos -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Sat, 5 Feb 2005 10:02:26 -0800 (PST)
Guy Hass asked:
When new people come on board, there is no set of
documentation, help screens, written procedures for
them -- they have to learn from the existing staff.
How do you go about mining and organizing such
material?
Tony Markos responds:
This is a classic Business Analysis project; many TW's
do BA type work. The main tools of BA's are Data Flow
Diagrams (DFDs), and there cousin: Entity Relationship
Diagrams (ERDs).
Your first step on the project is so critical. The
worst thing you can do is to just start typing
procedure - without first organizing.
The major input into organizing procedure is to come
with a rigorous understanding of essential
tasks/functions and essential data relationships.
This is where the DFD's and ERD's come into play.
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
Doc-To-Help 7.5 Professional: New version with new features, improved performance and reliability, plus much more! Download your free trial today at www.componentone.com/techwrlfeb.
---
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.