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.
Our developers are in the process of analyzing an existing system. As-built
documentation exists for version 3.0. We are currently on version 3.1. Analysis needs to be done, because version 4.0 may include some redesign as well as enhancements.
The problem: A high percentage of our development staff is new. We need to
maintain an online dialog about the system to share information quickly and easily.
At the same time, information needs to get stored where it can be found when a
question comes up on a particular item without having to dig through lots of other
comments.
It will not be sufficient to update and reprint the existing as-built design document,
because it isn't indexed. The table of contents is not sufficient to find many things.
I don't have time to do even a mediocre index.
Here's what I'm considering and I'd like feedback on possible benefits and pitfalls:
1. Convert the as-built design to an online documentation system.
2. Set up a shared location for annotations file. (UNIX/Hyperhelp this is possible.)
My reasoning is this:
1. This system would be accessible to all the developers (Word files are not.)
2. A shared annotations file would allow the developers to see each others comments
as soon as they are entered.
3. Developers might be more comfortable putting questions and thoughts in process
into an annotation file than they would be into a Word document which looks
more final.
4. Less frequent update to documents on my part.
5. The find tab option in the online doc would allow them access to the document
content that they don't currently have without an index.
Anyone used shared annotations files? Any problems?
Any alternative suggestions as to approach?
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
