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: Content Moratorium From:jgarison -at- ide -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 22 Mar 2001 15:03:14 -0500
Colin Green wrote..
> Question: Given the flux of software applications in development, and my
> inability to affect that schedule, what is a reasonable demand for a tech
> writer on content moratorium? That is, what can I reasonably demand for
> number of days/weeks that the product be stable in order to compose a
final
> draft?
My strategy is to figure out what the most the product could do is, and then
write a "skim coat" for everything so that at least everything is minimally
documented. Then, using the skills I teach in my patented "Swamp Draining"
metaphor, I figure out which pieces of the software morass will harden
first, and document them. Then, as more of the swamp becomes terra firma, I
move on and document the solid ground. Eventually, there are still one or
two quicksand areas that I step around as trepidaciously as possible, trying
to catch them as they dry up. This usually gets me as close to getting
everything described as possible at the time they ship. Of course, I keep a
weather eye out on those pieces of dried up sod, too, as often someone is
tempted to add a new hillock, or dig something up that used to work and
replace it with something that may or may not work, but is certainly
different.
If I put too much time and effort into the perpetually slushy stuff,
something awful happens - like they decide to not ship that chunk and I have
wasted a lot of time watching swamp dry when I could have been doing
something more useful.
Well, it makes sense to me ... and I'm starting to sound like Andrew!!!
John
John Garison
Documentation Manager
IDe
150 Baker Avenue Extension
Concord, MA 01742
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
IPCC 01, the IEEE International Professional Communication Conference,
October 24-27, 2001 at historic La Fonda in Santa Fe, New Mexico, USA.
CALL FOR PAPERS OPEN UNTIL MARCH 15. http://ieeepcs.org/2001/
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
