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.
Jane Lorenzen wrote the following pertaining to internal software
development and tech writing:
>When my manager asked me what the solution might be, I said, "I.S.
>should have tech writers. They'd produce and update docs as systems are
>developed and updated." So now he wants me to "write something up" for
I'm in the same boat. I'm lucky though, because our I.S. release
coordinator already knew that having a permanent documentation staff
would 1) give developers more time to focus on what they do best
(although they still have to review documentation) 2) ensure that
documents get created, and on time, and 3) ensure that documentation is
complete and usable. The documentation person also acts a liaison
between the developers and the support personnel (end users). It's
great to have my audience right here in the building so I can ask them
what their needs are and then make sure I get that information from the
developers and into the documentation.
Watch out though, because once you do have a in-house I.S. documentation
staff, there are many other tasks (admin) that shouldn't be overlooked:
filenaming standards, style guidelines, network structure, security of
documents, scheduling, and so on. These tasks though are another
feature of what an I.S. tech writer adds to the process that you can
promote. Organizing all of these tasks helps to ensure that your
audience gets what they need to do their jobs, and when they can perform
their jobs more effectively, the bottom line is affected in a way
management understands: our company is more efficient=our company
Senior Technical Writer, Information Systems
laura -dot- beckman -at- cexp -dot- com
All opinions are my own, not necessarily those of Corporate Express.