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: Another Newbie question about procedures From:HBacheler -at- aol -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 18 May 2005 12:58:39 EDT
Mary, et al
It might seem logical to have each step stand alone.
Especially if someone 'added' one or more steps in the process that you are
documenting.
There should relative be a one to one relationship to the action.
In my writing, I have drawn some simple logic flows, diagrams, even DFD's to
ensure that I know the process.
If we as tech writers are involved from 'day one' of the project, we can aid
in ensuring that the flow of information, decision-making, and pitfalls are
identified early in the 'game'. We can ask questions, make suggestions, and
begin the outline of our documents to reflect 'what the heck is going on'.
It then relatively easy to talk to the SMEs, engineers, and process owners
and ask informed questions.
New from Quadralay Corporation: WebWorks ePublisher Pro!
Completely XML-based online publishing. Easily create 14 online formats, including 6 Help systems, in a streamlined project-based workflow. Word version ships in June, FrameMaker version ships in July. Sign up for a 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.