Numbering Systems for Technical Service Manuals

[nancy carpenter]

I still use the numeric outline form for all the large documents.  We often
go down 3 or 4 levels below the chapter, and the numbering makes it clear
where we are.

Nancy Carpenter
Lead Technical Writer
GENCO Distribution System
100 Papercraft Park
Pittsburgh, Pennsylvania 15238


|---------+------------------------------------------------------->
|         |           "Linda G. Gallagher"                        |
|         |           <lindag at techcomplus.com>                    |
|         |           Sent by:                                    |
|         |           framers-bounces+carpentn=genco.com at lists.fra|
|         |           meusers.com                                 |
|         |                                                       |
|         |                                                       |
|         |           05/16/2006 05:57 PM                         |
|         |           Please respond to lindag                    |
|         |                                                       |
|---------+------------------------------------------------------->
  >----------------------------------------------------------------------------------------------|
  |                                                                                              |
  |       To:       "Gillian Flato" <gflato at nanometrics.com>, <framers at frameusers.com>           |
  |       cc:                                                                                    |
  |       Subject:  RE: Numbering Systems for Technical Service Manuals                          |
  >----------------------------------------------------------------------------------------------|




I only use that type of numbering when a client insists on it. Typically,
those clients are engineers with content targeting other engineers.

~~~~~~~~~~~~~~~~~~
Linda G. Gallagher
TechCom Plus, LLC
Intelligent technical communication since 1993
Technical writing, help development,
FrameMaker and WebWorks Publisher conversions
lindag at techcomplus.com
http://www.techcomplus.com/
303-450-9076
800-500-3144
~~~~~~~~~~~~~~~~~~
Manager, Consulting and Independent Contracting
Special Interest Group
Society for Technical Communication
http://www.stcsig.org/cic/index.html
~~~~~~~~~~~~~~~~~~


-----Original Message-----
From: framers-bounces+lindag=techcomplus.com at lists.frameusers.com
[mailto:framers-bounces+lindag=techcomplus.com at lists.frameusers.com]On
Behalf Of Gillian Flato
Sent: Tuesday, May 16, 2006 1:09 PM
To: framers at frameusers.com
Subject: Numbering Systems for Technical Service Manuals


Guys,

When you write a Technical Manual do you number heads and sections with
1.1, 1.2, 1.2.1 etc. I have a manual which is essentially an API and
it's numbered that way. It looks very cluttered to me. By taking that
out and using conventional styles, it has an easier UI to me.

What's the general consensus on numbering with the 1.1, 1.1.1, 1.2 type
of way? Is that generally history now, or is it actually still used a
lot?


Thanks,

Gillian Flato

Technical Writer (Software)

NANOmetrics, Inc.

1550 Buckeye Dr.

Milpitas, CA. 95035

(408.435.9600 x 316

7  408.232.5911

* gflato at nanometrics.com <blocked::mailto:v at nanometrics.com>




This message (including any attachments) may contain confidential
information intended for a specific individual and purpose. If you are not
the intended recipient, delete this message. If you are not the intended
recipient, disclosing, copying, distributing, or taking any action based on
this message is strictly prohibited.
_______________________________________________


You are currently subscribed to Framers as lindag at techcomplus.com.

Send list messages to framers at lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscribe at lists.frameusers.com
or visit
http://lists.frameusers.com/mailman/options/framers/lindag%40techcomplus.com


Send administrative questions to lisa at frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.




_______________________________________________


You are currently subscribed to Framers as carpentn at genco.com.

Send list messages to framers at lists.frameusers.com.

To unsubscribe send a blank email to
framers-unsubscribe at lists.frameusers.com
or visit
http://lists.frameusers.com/mailman/options/framers/carpentn%40genco.com

Send administrative questions to lisa at frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.