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:Systems documents From:Ron Sering CDS <ronaldse -at- MANX -dot- CDS -dot- TEK -dot- COM> Date:Tue, 29 Jul 1997 14:34:47 MDT
There is a dark cloud gathering over my cubicle. I am hearing rumblings that I will be responsible, as the Lone Tech Writer, for developing and maintain all systems documentation, such as system requirements, design specs, etc.
This troubles me, as I feel that there are plenty of issues directly related to user documentation, such as improving the online help effort, researching and developing ways of making documentation available over the internet and on CD, to single-source or to not single-source, that I need to be working on. In my background, the programmers/engineers produce the design documents, which I use as a basis for developing the user documentation.
What have been your experiences with systems documentation?
- Ron Sering
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
