RE: opinion on outline numbering for chapters/sections

Subject: RE: opinion on outline numbering for chapters/sections
From: "Bonnie Granat" <bgranat -at- granatedit -dot- com>
To: "'Gina Jones'" <gina -dot- techwriter -at- gmail -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 11 Jun 2008 14:12:28 -0400

The text you write under the heading "2.2.1 Set Up Software Web
Appliance," should present enough information for the reader to understand
that the subsections are steps. There is no need, in my opinion, to further
burden the reader with A), B), C), etc. If the subsections are all steps,
which it appears that they are, the text of the headings are right there for
all to see. So I'd recommend discarding the A), B), C), etc.

Bonnie Granat

> -----Original Message-----
> From:
> techwr-l-bounces+bgranat=granatedit -dot- com -at- lists -dot- techwr-l -dot- com
> [mailto:techwr-l-bounces+bgranat=granatedit -dot- com -at- lists -dot- techwr-l
> .com] On Behalf Of Gina Jones
> Sent: Wednesday, June 11, 2008 1:59 PM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: opinion on outline numbering for chapters/sections
> Hey Everyone,
> I'm normally a lurker. I benefit from this list and thank all
> of you for your participation.
> I need some opinions on my numbering sequence in a User
> Guide. My client specifically requested that I embed the
> Quick Start into the manual and provide more details. I'm not
> a fan of outline numbering in user guides, but must follow
> their corporate style guide. Below is this particular
> numbering sequence.
> *
> 2.2*** Software Quick Start
> 2.2.1 Set Up Software Web Appliance
> A) Configure the Web Appliance
> <Step/Action table here>
> 1
> 2 a)
> b)
> c)
> d)
> e)
> f)
> B) Configure the Analyzers
> <Step/Action table here>
> 1
> 2
> C) Connect the Switch to the Analyzers
> <Step/Action table here>
> 1
> 2
> D) Connect the Ethernet.
> E) Access the Web Application.
> <Step/Action table here>
> 1
> 2
> 2.2.2 Set up Downstream Monitoring
> Once I get to I feel that the instructions become
> confusing, so I put A), B), C), etc. at the beginning of the
> headings since they are part of the sequence of steps.
> However, now I'm thinking that it makes it more confusing.
> What do you think?


Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

opinion on outline numbering for chapters/sections: From: Gina Jones

Previous by Author: RE: Display, Displays, or Appears
Next by Author: RE: Display, Displays, or Appears
Previous by Thread: Opinion on outline numbering for chapters/sections?
Next by Thread: Re: opinion on outline numbering for chapters/sections

What this post helpful? Share it with friends and colleagues:

Sponsored Ads