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: Reference Manual From:"Hager, Harry (US - East Brunswick)" <hhager -at- dc -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 31 Jan 2001 09:51:03 -0500
Here is something that may be useful. It's something I originally wrote a
while back for another company and have sort of added to as the technolgy
hhager -at- dc -dot- com
Technical Reference Manuals
Technical reference manuals describe the programs and the files of a
software application. Technical reference manuals are usually not read in
sequential order. Instead, individual sections are read (referred to) as
needed. Technical reference manuals are also sometimes called systems
documentation or simply, reference manuals.
For technical reference manuals, one size does not fit all.
Following is a list of characteristics of typical reference manuals:
· Purpose: Describes the structure, function, and capabilities of the
individual software components of the application, such as programs, command
procedures, and data files. The reference manual is generally free of any
task-oriented material unless system administration procedures are included.
· Audience: Persons who are responsible for maintaining the software
application and those who are responsible for responding to the user
questions about technical details of the application.
· Content & Organization: No single content structure or organization is
suitable for all reference manuals. Following are some typical example
sections in a reference manual (Note that there is some overlap in these
examples because these examples are compiled from several different manuals
for several different types of software):
· Purpose of the software (User tasks or functions performed by the
· Technical architecture
· Hardware and software requirements
· Command procedures / statements
· User menus and menu commands (user interface)
· User data entry screens and fields (user interface)
· Database architecture
· System administration procedures
Can someone give me a definition of a reference manual or give me an example
of one? A recruiter has asked if I'd ever written one, and I wasn't sure if
I had because I may have never heard it referred to as that.
This message (including any attachments) contains confidential information
intended for a specific individual and purpose, and is protected by law. If
you are not the intended recipient, you should delete this message and are
hereby notified that any disclosure, copying, or distribution of this
message, or the taking of any action based on it, is strictly prohibited.
Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area. http://www.pdfconference.com or toll-free 877/278-2131.
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.