Heading Hierarchy for a Complex Manual

Subject: Heading Hierarchy for a Complex Manual
From: "Kirk Turner" <royj -at- alltel -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 7 Nov 2005 12:16:01 -0500


I am in the process of editing a very long and complex manual. I am
writing the style guide, and I am on the section on heading hierarchy.
Except for the unwieldy APA guidelines, I haven't found any guidance on
the subject. I have the Chicago Manual of Style guidelines, but I don't
see any examples or suggestions that relate to what I am doing. But I
used what was in the Chicago Manual of Style anyway and came up with
these levels of heading (this is for an online manual):

. The first level heading will be Verdana, 14 pt., upper and lower
case, underlined and centered.

. The second level will be Verdana, 14 pt., centered, uppercase and
lowercase.

. The third level will be Verdana, 12 pt., flush left, uppercase and
lowercase and underlined.

. The fourth level heading will be Verdana, 12 pt., one tab from left
and capitalized as it would be in a sentence.

. The fifth level of heading will be Verdana 12 pt., two tabs from the
left and underlined. End this heading with a period and begin the first
sentence of the body text for this heading on the same line as the
heading.


Does this sound right? Is the Chicago Manual of Style a good reference
for a complicated technical manual? I have an example using it on paper,
and it looks odd to me. Most of my editing jobs have been for technical
journals. I hate to question the venerable Chicago Manual of Style, but
this looks odd. Is there a more authoritative source for technical
manuals? Have I interpreted the Chicago heading hierarchy correctly?
Maybe it is just fear of failure clouding my vision. Any guidance would
be greatly appreciated.




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Try WebWorks ePublisher Pro for Word today! Smooth migration of legacy
RoboHelp content into your new Help systems. EContent Magazine Decision-
maker review (October 2005) is here: http://www.webworks.com/techwr-l

Doc-To-Help 2005 converts RoboHelp files with one click. Author with Word or any HTML editor. Visit our site to see a conversion demo movie and learn more. http://www.componentone.com/TECHWRL/DocToHelp2005

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Follow-Ups:

Previous by Author: ROBOHELP: Opening a second chm file from a current help window
Next by Author: Dual-use font
Previous by Thread: Re: techwr-l digest: November 06, 2005 - ISO Project 11
Next by Thread: Re: Heading Hierarchy for a Complex Manual


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

Sponsored Ads


Sponsored Ads