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.
Help solicited on writing Technical reference manual
Subject:Help solicited on writing Technical reference manual From:"Jayasree Suryanarayanan" <jayasree -at- actionaid -dot- net-kraft -dot- com> To:techwr-l -at- lists -dot- raycomm -dot- com Date:Thu, 04 Jan 1996 06:39:25 +0530
Hi ,
I have to write a technical reference manual for our client ,and would
like to know what else should go into the manual apart from what little
information I have gathered( outlined below).
These are the topics I propose to address in my tech ref manual:
Introduction to the system
Functional decomposition of the system and the logic behind such a
breakup
System Flow charts
Logical Data Structure
Entity Attributes and Description
Module wise flow charts
Physical data base design that would include:
Table Structure
Attribute Description
Validation
Referential integrity
Entity Event Matrix (does this refer to the input - output activites of
each process ?)
Error messages
System Audit , Trouble shooting
Limitation of the soft ware
I would like you to guide me on how I should go about gathering
information on these topics, the tools I should use and a brief outline
of the importance of each
item of the table of contents . I would appreciateyour help in this
regard as I have never written a technical reference manual before . If
any of you are aware of sites that address the above topics kindly
enlighten me .
