Re: Heading Hierarchy for a Complex Manual

Subject: Re: Heading Hierarchy for a Complex Manual
From: Brian Gordon <elasticsoul2003 -at- yahoo -dot- ca>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 7 Nov 2005 12:30:30 -0500 (EST)

--- Kirk Turner <royj -at- alltel -dot- net> wrote:

> I am in the process of editing a very long and
> complex manual.
> Does this sound right?
> 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.

For long and complex documents, I find numbered
headings to be helpful to me when writing, and to
readers when reading. It helps keep people from
getting lost.

I am also not a big fan of indented headings, because
then the document takes on a look that I find harder
to follow than flush-left numbered headings. For
example, I've seen docs with indented headings but
flush-left text, and this seems to make the headings
less readily noticeable.

All the best,


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:

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.

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 for more resources and info.

Heading Hierarchy for a Complex Manual: From: Kirk Turner

Previous by Author: Re: Alternate Title to Tech Writer?
Next by Author: Re: Quickie Active Voice Question
Previous by Thread: Heading Hierarchy for a Complex Manual
Next by Thread: Re: Heading Hierarchy for a Complex Manual

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

Sponsored Ads

Sponsored Ads