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: Documenting a Moving Target--Update From:Karen Gwynn/Datatel <Karen_Gwynn -at- DATATEL -dot- COM> Date:Wed, 21 Feb 1996 11:56:50 EDT
Thanks to everyone who responded to my plea yesterday. I'm kinda embarrassed
though, because I wrote note in the heat of the moment: bad choice.
After I sent my posting, I was able to speak with my supervisor (of course when
I was frantic, she wasn't at her desk). Anyway, one thing that I did not know
is that there is a programming cutoff, scheduled for NEXT MONTH,which should
freeze work on the current functionality, except for tweaking and such (we are
in beta/QA now). Although there are some global system areas that will be
developed, the basic documentation that I've been working on shouldn't change
too drastically after that point.
Also, for those of you who responded and mentioned this: I _am_ on the
development team; documentation _is_ part of our process; and developers (at
least management and senior folk) _do_ have a certain level of vested interest
in doc. Actually, for my company, I am working on an ideal project as far as
the interaction of doc and developement. My cube (I hate 'em) is across from
the lead developer of the module I am documenting!! However, none of this seems
to help the fact that programmers make so many "minor" changes that affect
interface and therefore doc that they don't (1) always remember to notify the
tech writers and (2) don't even document it for themselves. I guess that will
just have to come with time... (we call it continous process improvement!)
Anyway, thanks again to everyone. There was some good advise that I plan on
keeping and sharing with my colleagues here.
Karen Gwynn, Senior Documentation Specialist
e-mail kwg -at- datatel -dot- com