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: Is it just me? S/W doc question From:"Robin M. Allen" <robin -dot- m -dot- allen -at- WORLDNET -dot- ATT -dot- NET> Date:Thu, 29 May 1997 09:35:36 -0500
Melissa Hunter-Kilmer wrote:
>
> Those of you who don't document software might want to delete
> this message.
>
> For those of you who do --
>
> When you're documenting an application, and it changes, is there
> a procedure in place to notify all concerned? Or do you just
> find out after you've written the chapter, and then you have to
> rewrite it?
Melissa:
Depending on how complete the software is when you start documenting,
it's natural to document a feature and then have it change. Typically, I
stumble upon the change after I've documented the feature, or I hear
rumors that things are changing so I know what to look for. I'm a
contractor, and unfortunately, most companies I have worked for don't
make it a practice to provide release notes (and if they do, they're
inadequate).
It's difficult and sometimes counter-productive to work this way, and
companies don't seem to understand that they *pay* for me to discover
these changes and re-document the software. I guess it just comes down
to money. Is it cheaper to have a programmer take time to document sw
changes or have the tech writer duplicate effort?
:Robin Allen
robin -dot- m -dot- allen -at- worldnet -dot- att -dot- net
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html