TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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
sequence.
*
2.2*** Software Quick Start
2.2.1 Set Up Software Web Appliance
2.2.1.1 A) Configure the Web Appliance
<Step/Action table here>
1
2 a)
b)
c)
d)
e)
f)
2.2.1.2 B) Configure the Analyzers
<Step/Action table here>
1
2
2.2.1.3 C) Connect the Switch to the Analyzers
<Step/Action table here>
1
2
2.2.1.4 D) Connect the Ethernet.
2.2.1.5 E) Access the Web Application.
<Step/Action table here>
1
2
2.2.2 Set up Downstream Monitoring
Once I get to 2.2.1.1 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. http://www.DocToHelp.com/TechwrlList
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-