opinion on outline numbering for chapters/sections

Subject: opinion on outline numbering for chapters/sections
From: "Gina Jones" <gina -dot- techwriter -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 11 Jun 2008 13:59:11 -0400

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
2.2*** Software Quick Start
2.2.1 Set Up Software Web Appliance A) Configure the Web Appliance
<Step/Action table here>
2 a)
f) B) Configure the Analyzers
<Step/Action table here>
2 C) Connect the Switch to the Analyzers
<Step/Action table here>
2 D) Connect the Ethernet. E) Access the Web Application.
<Step/Action table here>

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?

Thanks all!


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! http://www.helpandmanual.com

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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com

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
http://www.techwr-l.com/ for more resources and info.


Previous by Author: Re: You VS One
Next by Author: RE: Yo-ho! A jolly new Olde English axiom-axing.
Previous by Thread: RE: Text Frames on Graphic
Next by Thread: Opinion on outline numbering for chapters/sections?

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

Sponsored Ads