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:Re: Technical Reference Manual From:Reuven Frank <reuven -at- E-AND-C -dot- COM> Date:Thu, 20 Aug 1998 11:25:05 +0200
I use what I consider to be the basic format for these systems:
An Overview/Introduction
A list of modules in order of data flow
Separate chapters for each module.
I usually add a theory of operation chapter, a glossary of technical terms, and, of course
a TOC and an Index.
Feel free to write for help with details.
Reuven Frank
Technical Documentation
E&C Medical Intelligence
reuven -at- e-and-c -dot- com
----------
From: Lisa Depenbrock
Sent: Wed, 19 Aug.98 14:11 PM
To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Subject: Technical Reference Manual
Hello everyone,
I may have to write a technical reference manual for my company's
software product. Can anyone give me any helpful hints about the format
and content of such a document?
