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.
We have the responsibiliy of creating a document library for a fairly new
techwriting department. We are trying to name standard document types,
rather than the hybrids some of us have worked on. I have a twofold
division of questions:
1. What is a standard name for a document you distribute between major
release and that contains service patch intructions, such as changes to
2. Here is our list of documents. Does anyone know a site where I can find
examples and definintions of each? Can anyone add to the list (we do not do
any of the programmers' design docs or the like):
* user guides
* reference guides
* quick reference guides
* application notes
* technical reference manuals
* technical specifications
* white papers
* installation guides
* programmers' guides
* release notes
* policies and procedures
* installation and operation guides for hardware
* disaster and recovery
I know this request seems naive to many of you more-seasoned pros, but we
could use the help.
Clear Technology, Inc.
303-583-4170 (direct line)
ellen -dot- vanrenen -at- clear-technology -dot- com
WARNING - THIS E-MAIL TRANSMISSION IS CONFIDENTIAL. This e-mail transmission
(including any accompanying attachments) contains confidential information
which is intended for the named addressee only. If you are not the intended
recipient, you are hereby notified that any use, dissemination, distribution
or reproduction of this e-mail is prohibited. If you have received this
e-mail in error please contact me immediately. Thank you.
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.