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: Gerunds in titles and headings From:"Amy G. Peacock" <apeacock -at- WOLFENET -dot- COM> Date:Tue, 12 Jan 1999 11:15:02 -0800
On Tue, 12 Jan 1999, Porrello, Leonard wrote:
> If you go with the "How to. . ." construction, however, your automatically =
> generated table of contents might a little less than absolutely user friend=
> ly, with several chapter or sub-heading beginning with "How to . . . ."
Hmmm...that's true. I set my headings up using a first or second level
heading for the stuff like "Editing your document" and then I have
another heading (a level below the heading) that says "How To..." This
way I get a ToC with helpful headings as well as the How To... part.
So, a section might look something like this:
Editing you Document
Introduction
(introductory/basic text about the topic
How To...
(the actual steps to doing the task)
More About...
(tips, tricks, stuff to watch for and details about the task -
each of which might have a sub-heading of its own under the
heading)
Of course, it get more complex once you start working on a complex
project. :) But this way the user can look in the ToC and find the
basic section itself, the How To... section so they can finish their
task, or the More About... section if they are trying to troubleshoot
something or want to know some shortcuts.
So far so good - although getting feedback from my users is like
pulling teeth...
Amy Peacock
techwriter & jewelrymaker
Snohomish, Washington
apeacock -at- wolfenet -dot- com
"How do I set my laser printer to stun?"
-----------------------------------------
21 days until Imbolc