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.
I'm looking for advice/thoughts/philosophical diatribes on this subject:
Who manages software design documentation? Specifically, I'm in a
situation where we outsourced a process document (the software does this,
then it does this, and this is how it does what it does...). Now it's
morphing into the core of our application's design.
The product manager wants to be able to write changes to the design as
they occur--and intimates that she wants me "to pretty it up" on
occasion. My suggestion was
* to define to doc along with her
* create an info plan for the tech doc suite for the program
* then define a content spec
* _then_ to have her collect tech info & zap it to me electronically
* I woul then organize, edit, & draft
* she would _tech_-edit
* I would publish electronically for all developers to use (Acrobat)
* she would collect tech info (and here the cycle repeats)
I'm afraid the devel community wants to simply write things out (in very
conditional/exception-processing approach--if this, then that; if the
one, then the other) and pass off to me for a "quick edit."
Any suggestions on how to get a handle on this process? Judy Glick-Smith
had a great discussion of this type of subject at the STC conference, but
I'm looking for some more, specific thoughts....
Thanks!
joe
TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-