Gaskill; Framers List
Subject: Re: Confirmation: : Numbering Systems for Technical Service
Manuals
At 3:10 AM -0700 5/19/06, Diane Gaskill wrote:
ALL of the
documentation within the company - literally a billion pages or more - uses
numbered headings. Yes, some of the docs are written by engineers
Gaskill; Framers List
Subject: Re: Confirmation: : Numbering Systems for Technical Service
Manuals
At 3:10 AM -0700 5/19/06, Diane Gaskill wrote:
> ALL of the
>documentation within the company - literally a billion pages or more - uses
>numbered headings. Yes, some of the docs ar
At 11:16 -0700 18/5/06, Daniel Emory wrote:
Nevertheless, this issue about numbering of titled headings, tables and
graphics seems to come up frequently. It's a valid issue, and it deserves more
discussion on the list.
Surely the answer here is 'horses for courses'? There are many areas where
-
From: [EMAIL PROTECTED]
[mailto:[EMAIL PROTECTED]
Behalf Of [EMAIL PROTECTED]
Sent: Thursday, May 18, 2006 12:08 PM
To: Framers@frameusers.com
Subject: RE: Numbering Systems for Technical Service Manuals
I'm not familiar with versions of FM help prior to vers. 7, which I am
using. That, I can agree
or online. We use links in the online docs too, but they
are xrefs and include the numbered headings they refer to.
Diane
===
-Original Message-
From: Daniel Emory
Sent: Thursday, May 18, 2006 8:31 AM
To: Framers List
Subject: RE: Numbering Systems for Technical Service
At 3:10 AM -0700 5/19/06, Diane Gaskill wrote:
ALL of the
documentation within the company - literally a billion pages or more - uses
numbered headings. Yes, some of the docs are written by engineers to other
engineers, but much of the product documentation goes to the customers, most
of whom
I appreciate everyone's feedback on this issue. I have learned a lot.
So here's the long and short of what I did.
After taking the numbered heads out of a very technical manual, my
engineers asked me to put them back in. I talked to the software manager
and he said that for this manual,
--- Steve Rickaby [EMAIL PROTECTED]
wrote:
Surely the answer here is 'horses for courses'?
There are many areas where numbering is either
appropriate or essential (engineering manuals,legal
documents, political documents, medical documents,
repair manuals, ya-de-yah), and others where it is
At 11:16 -0700 18/5/06, Daniel Emory wrote:
>Nevertheless, this issue about numbering of titled headings, tables and
>graphics seems to come up frequently. It's a valid issue, and it deserves more
>discussion on the list.
Surely the answer here is 'horses for courses'? There are many areas
Original Message-
From: framers-bounces+dgcaller=earthlink@lists.frameusers.com
[mailto:framers-bounces+dgcaller=earthlink.net at lists.frameusers.com]On
Behalf Of Laura_J_Kirk at bd.com
Sent: Thursday, May 18, 2006 12:08 PM
To: Framers at frameusers.com
Subject: RE: Numbering Systems f
or online. We use links in the online docs too, but they
are xrefs and include the numbered headings they refer to.
Diane
===
-Original Message-
From: Daniel Emory
Sent: Thursday, May 18, 2006 8:31 AM
To: Framers List
Subject: RE: Numbering Systems for Technical Service
At 3:10 AM -0700 5/19/06, Diane Gaskill wrote:
> ALL of the
>documentation within the company - literally a billion pages or more - uses
>numbered headings. Yes, some of the docs are written by engineers to other
>engineers, but much of the product documentation goes to the customers, most
>of
I appreciate everyone's feedback on this issue. I have learned a lot.
So here's the long and short of what I did.
After taking the numbered heads out of a very technical manual, my
engineers asked me to put them back in. I talked to the software manager
and he said that for this manual, (which
--- Steve Rickaby
wrote:
> Surely the answer here is 'horses for courses'?
> There are many areas where numbering is either
> appropriate or essential (engineering manuals,legal
> documents, political documents, medical documents,
> repair manuals, ya-de-yah), and others where it is
> not. Legal
--- Linda G. Gallagher [EMAIL PROTECTED]
wrote:
I don't think it was necessary to single out my
response and call what I
said laughable.
Your unqualified statement that the only people left
who use such numbering schemes are engineers
communicating with other
]
meusers.com] On Behalf Of Daniel Emory
Sent: Thursday, May 18, 2006 11:31 AM
To: [EMAIL PROTECTED]
Cc: Framers List
Subject: RE: Numbering Systems for Technical Service Manuals
--- Linda G. Gallagher [EMAIL PROTECTED]
wrote:
I don't think it was necessary to single out my response
and call
--- Anne Robotti [EMAIL PROTECTED] wrote:
Is this a private email from Linda that you posted
to the list? How
completely rude.
=
My mistake, and I apologize to Linda. The Framer's
list, unlike some others, identifies the sender's
name, not the list's name as the
To
Framers List framers@FrameUsers.com
cc
Subject
RE: Numbering Systems for Technical Service Manuals
--- Anne Robotti [EMAIL PROTECTED] wrote:
Is this a private email from Linda that you posted
to the list? How
completely rude.
=
My mistake, and I apologize to Linda
Excellent post Dan. Your post was exactly what I wanted (but was too lazy)
to post as soon as I saw the original post about numbering.
Far too often I see technical writers complaining about layout, format,
or organisation because they simply don't like it or it doesn't look
right. And then
--- "Linda G. Gallagher"
wrote:
> I don't think it was necessary to single out my
> response and call what I
> said laughable.
Your unqualified statement that the only people left
who use such numbering schemes are engineers
communicating with other engineers is
ister.com at lists.frameusers.
> com
> [mailto:framers-bounces+arobotti=journalregister.com at lists.fra
meusers.com] On Behalf Of Daniel Emory
> Sent: Thursday, May 18, 2006 11:31 AM
> To: lindag at techcomplus.com
> Cc: Framers List
> Subject: RE: Numbering Systems for Technical Servic
--- Anne Robotti wrote:
> Is this a private email from Linda that you posted
> to the list? How
> completely rude.
=
My mistake, and I apologize to Linda. The Framer's
list, unlike some others, identifies the sender's
name, not the list's name as the sender. My default
ers.com
05/18/2006 02:16 PM
To
Framers List
cc
Subject
RE: Numbering Systems for Technical Service Manuals
--- Anne Robotti wrote:
> Is this a private email from Linda that you posted
> to the list? How
> completely rude.
=
My mistake, and I
Hi, Laura:
At 3:08 PM -0400 5/18/06, Laura_J_Kirk at bd.com wrote:
>I'm not familiar with versions of FM help prior to vers. 7, which I am
>using. That, I can agree wholeheartedly, sucks.
>
>As a self-taught FM user, it takes hours, literally hours to figure out
>some new operation or feature in
Excellent post Dan. Your post was exactly what I wanted (but was too lazy)
to post as soon as I saw the original post about numbering.
Far too often I see "technical" writers complaining about layout, format,
or organisation because they simply "don't like it" or "it doesn't look
right".
@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
t 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 whic
--- "Linda G. Gallagher"
wrote:
> I only use that type of numbering when a client
> insists on it. Typically,
> those clients are engineers with content targeting
> other engineers.
==
The complaint that prompted Ms. Gallagher's response
was that multi-level
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
I think it's still mostly used in environments where the manuals are
written to a standard
that requires it: MilSpec, BellCore, whatever
In civilian docs, I think it's largely faded away.
Art
On 5/16/06, Gillian Flato [EMAIL PROTECTED] wrote:
Guys,
snip
What's the general consensus on
PROTECTED]
[mailto:[EMAIL PROTECTED]
On Behalf Of Art Campbell
Sent: Tuesday, May 16, 2006 1:20 PM
To: Gillian Flato
Cc: framers@frameusers.com
Subject: Re: Numbering Systems for Technical Service Manuals
I think it's still mostly used in environments where the manuals are
written to a standard
., and there was no fourth
level).
ljk
___
Deja Moo: The feeling that you've heard this bull before.
Gillian Flato [EMAIL PROTECTED]
Sent by: [EMAIL PROTECTED]
05/16/2006 03:09 PM
To
framers@frameusers.com
cc
Subject
Numbering Systems for Technical Service
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
I think it's still mostly used in environments where the manuals are
written to a standard
that requires it: MilSpec, BellCore, whatever
In "civilian" docs, I think it's largely faded away.
Art
On 5/16/06, Gillian Flato wrote:
> Guys,
> What's the general consensus on numbering with the
Original Message-
From: framers-bounces+grant.hogarth=reuters@lists.frameusers.com
[mailto:framers-bounces+grant.hogarth=reuters.com at lists.frameusers.com]
On Behalf Of Art Campbell
Sent: Tuesday, May 16, 2006 1:20 PM
To: Gillian Flato
Cc: framers at frameusers.com
Subject: Re: Numbering
., and there was no fourth
level).
ljk
___
Deja Moo: The feeling that you've heard this bull before.
"Gillian Flato"
Sent by: framers-bounces+laura_j_kirk=bd.com at lists.frameusers.com
05/16/2006 03:09 PM
To
cc
Subject
Numbering Systems for
~~
-Original Message-
From: framers-bounces+lindag=techcomplus@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
37 matches
Mail list logo
