RE: Documentation Types (repost)

["Steve Hudson" <steve -at- wright -dot- com -dot- au>]

1. The Supplemental?

2. Oh dear, oh me oh my. :-)

Corporate Documentation Hierarchy:
==================================

Standards
Policies
Strategies
Plans
Procedures    References
Instructions  Records


That's as generic as it gets. A Form is just a blank record, manuals are
collections of these documents ...


Then you get specific by divisional function, some non hierarchical
examples:

Development
-----------

Use Cases, Func Spec, Tech Spec, Bug Reports, Change management records

Product Support
---------------

User Guides
help systems, supplementals (Readme's (containing release notes, EULAs,
addendum, known bugs), reference sheets, rego cards, install text etc),
tutorials,

Documentation
-------------

Style Guides
Registers


Marketing
---------

Handouts, business cards, letterheads, logos, packaging, press releases,
flyers, brochures


Sales
-----

Customer database, financial database


Its an ENORMOUS list, I barely scraped the surface :-)

Steve Hudson
Principal Technical Writer
Wright Technologies (Aus)
steve -at- wright -dot- com -dot- au
(612) 9518-1822
The best way to predict the future... is to create it!



-----Original Message-----
From: bounce-techwr-l-62124 -at- lists -dot- raycomm -dot- com
[mailto:bounce-techwr-l-62124 -at- lists -dot- raycomm -dot- com]On Behalf Of Ellen
Vanrenen
Sent: Wednesday, September 19, 2001 8:30 AM
To: TECHWR-L
Subject: Documentation Types (repost)


Hello,

I sent the following message 9/12/01. I did receive several very helpful
answers, but I had a setback with my email and would dearly love to receive
those replies (and others) again. Here is the edited text of my original
message:

We have the responsibility 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
releases that contains service patch instructions, such as updates to
installation procedures?
2. Here is a list of documents. Does anyone know a site where I can find
examples, definitions and/or templates of each? Can anyone add to the list?
We do not write any of the programmers' design docs or the like:

*	application notes
*	technical reference manuals
*	technical specifications
*	white papers
*	installation guides
*	programmers' guides
*	policies and procedures
*	installation and operation guides for hardware
*	disaster and recovery


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A landmark hotel, one of America's most beautiful cities, and 
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe.  http://ieeepcs.org/2001/

  +++  Miramo -- Database/XML publishing automation.  See us at  +++
  +++  Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion  +++
  +++ More info: http://www.axialinfo.com  http://www.miramo.com +++

---
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.