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:Linking details to manual From:"Halter, Meg" <HalterMC -at- navair -dot- navy -dot- mil> To:"'Techwr-L Listerv'" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 29 Feb 2000 10:52:06 -0800
Hello techwhirlers --
I'm writing a user guide for a application and much of the information I'm
putting in comes from reading code, executing the application in debug, and
such like to determine exactly how things work. This process uncovers lots
of gruesome details that really don't belong in the user guide, but I don't
want to lose those gruesome details because I know questions about them will
come up. (This application is legacy code that is mostly undocumented.)
How do you do you folks handle linking gruesome details to the material that
makes it into the guide? Right now I'm using Word's comments feature for
short stuff, and separate word files and sometimes paper files for long
stuff. Though the system is working, it's cumbersome and I fear it will get
away from me before this project is done.
