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.
Subject:RE: Heading Hierarchy for a Complex Manual From:"Claire Conant" <Claire -dot- Conant -at- Digeo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 7 Nov 2005 09:30:28 -0800
Hi Kirk,
Just a couple points to start. First of all, if it is an online manual,
I would advise against underlining any headings. Underlines typically
represent a linked reference, so that could confuse the reader. They'd
get frustrated trying to click it and find it inactive.
I would also advise against centering any heading except for a cover
title, especially if this is going online. To me, it looks odd, and
makes the eye move around too much. Also, I'm wondering why you have the
first and second level headings in the same font size. Wouldn't you want
to differentiate them by a slightly smaller font for the second level
heading?
At my company, our heading one is 18 pt, heading two is 16 pt, and
heading three is 14 pt. Our body text is indented 1.0 inches, and
headings two and three align with body text. We typically don't go lower
than three heading levels, but your style may differ. We also don't use
numbered headings unless for something like our software development kit
or technical specifications.
A lot of your style may depend on other technical manuals your company
already has published. I would look there for some guidance. Or you
could look at other samples of published technical manuals and adapt
your style to follow, but tweaked for your own company image.
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.
