Great Technical Writing: User Document Headings Should Be Guideposts, Not Advertisements


E-mail this post



Remember me (?)



All personal information that you provide here will be governed by the Privacy Policy of Blogger.com. More...



OVERVIEW

Most heading are designed to entice us to read further. Headings in User Documents should enable your Reader to decide whether or not to continue reading that section. Use effective headings to make it easy for your Reader to access and understand your User Document.

MOST HEADINGS ARE FOCUSED ON GETTING THE READER TO READ MORE

Usually, these headings provide just enough information or use clever wording to tease the Reader to continue. Many User Document authors incorrectly do the same. Users do not want to read the User Manual, and they should only be encouraged to read text if it is of relevance to them. They should not be teased into reading irrelevant material.

Here are some examples of teaser-type headings:

* "TIP:"

The Reader does not know if the tip is relevant or not, and thus is forced to read the text to make a decision.

* "Headings Can Discourage Reading"

A teaser if ever there was one. Since it implies a contradiction, its goal is to get the Reader to read. If it's not important for every Reader to read this information, then you have misled your Readers.

Rather than tease, headings should:

* Enable your Reader to decide whether or not to read the text, or

* Provide enough information so that your Reader can skip the text

HEADINGS SHOULD HELP YOUR READER TO DECIDE WHETHER OR NOT TO READ ON

A good heading provides the information that your Reader needs to decide whether or not to read the text that follows it. It should not use any clever wording to entice the Reader to read unnecessary material.

Let's improve on the previous "teaser" examples:

* "TIP: USE WORD PROCESSOR STYLES"

Your Reader will skip this if he/she is already using styles to format their word processor documents.

* "Headings Can Provide Enough Information to Discourage Reading"

If your Reader understands what this means, then he/she can skip the material.

HEADINGS CAN PROVIDE ENOUGH INFORMATION TO DISCOURAGE READING

A good example is the step-by-step instruction. Headings should be part of any series of (step-by-step) instructions. Each heading tells the Reader what he/she will be doing in the following instruction steps. The Reader can decide to read or skip the text, based on the heading and his/her capabilities. For example:

Delete the CONFIG.STP File by Following These Steps:

1. ...

2. ...

3. ... etc

A Reader who knows how to find and delete the CONFIG.STP file can use the information in the heading alone to perform the desired task. A Reader who doesn't know how to perform the deletion will follow the more detailed steps.

In this situation, the heading helps the Reader self-select based on his/her skills.

DESCRIPTIVE HEADINGS PROVIDE GOOD ACCESS TO THE TEXT

Descriptive headings (that accurately describe the text that follows) enable your Readers to find desired information on the page. When skimming a page, Readers focus on the headings. It is much easier to browse headings than to browse text.

SOME USEFUL HEADING GUIDELINES

--- Don't Mix Information Between Headings

All of the information that follows a heading -- until the next heading -- should relate to the heading that introduces the text. Don't add information irrelevant to the heading in the text following that heading. Doing so makes it harder for your Reader to find material in your User Document, and confuses your Reader when reading the text ("why is this here?").

If necessary, add additional headings.

--- Consider Using More Headings in Your Writing

By having more headings, you reap the following benefits:

* There will be more "white space" in your document. These blank areas make your writing more inviting and easier to read.

* You provide more guideposts to the information. These additional guideposts make topics easier to find in your writing, and sets the tone for the text to follow.

--- Headings Should Stand Out from the Text

Make headings larger, bolder, set off from the plain text in the document. This will enable your Reader to easily find and use the headings. If you have no control over the font of the headings, put them in all capital letters.

--- Denote Headings with Your Word Processor's "Styles".

Use your word processor "styles" or equivalent to denote headings. The alternative is to manually format the headings to make them stand out.

By using "styles," all headings of a particular level will look the same; you can easily change appearance of all of the headings at once, and you can easily create Tables of Contents.

THE BOTTOM LINE

Users do not want to read User Documentation. By using headings that help your Reader to decide whether or not to read the text that follows, you make his/her reading experience more effective.

Headings are a powerful access mechanism for any kind of writing -- don't squander this power.

Barry Millman, Ph.D., has a Bachelor of Science in Electrical Engineering (1966, Carnegie Institute of Technology) and an M.Sc. and Ph.D. in Psychology (Human Information Processing, University of Calgary). Visit: http://www.greatuserdocs.com/ for resources to help you create great User Documents.Card Gift Navy Old
1999 Act Civic Participation Rehabilitation
Cleaning Fur Retail
Download Techno Music
Top Restaurant Washington Dc
Dog Food Health Natural
Uzbekistan Russia
Fiat Rims
Avatar Banana Dancing
Somerset Silver
Mineral Rock Set
Real9
2007 Article Global Recent Warming
How To Clean Dog Urine Out Of Carpet
Sell Your Timeshare
Estate Listing Maryland Multiple Real
Bride Dress Up Game
Bangkok Deal Hotel Last Minute
Dating
Vending Truck For Sale
5 Day Body Detox Plan
Real16
Couch Chaise
Disney Hotel California
Asbestos Exposure Mesothelioma
Olive Garden Zuppa Toscana Soup Recipe
Dating
Free Credit Consolidation
This Old House Com
Free Online Radio Reggae Station
Epa Fish Oil
Rock T Shirt Womens
Free Web Crawler
New York Construction News
Christmas Party Invitation Card
High School T Shirt Wrestling
Mtv
Advertising For
Sports Book Rating
Shark Tooth Necklace Earrings Jewelry Pendant
Alert Elder Medical
0 Blood Diet Type Type
5 Demo Evolution Pro Soccer
007 James Bond Gift Set
Ebay Store Ebay Auction
Designer Chanel Inspired Sun Glasses
Cafe Du Monde Beignet Mix
Torchiere Table Lamp
Misspelled Auctions
Costume Dress Fancy Kid
Trim Carpentry Techniques
Greatest Classic Rock Songs
Radio
Canada Credit Trans Union
Society Of Laparoendoscopic Surgeons
Cd Labeling
0870 Numbers
Earth Ship Space
10 Bracelet Gold Jewelry Karat Tanzanite White
Alaska Hiking
Am I Hot
1 Code Friend List Myspace Top
Best Designer Online Shoes Woman
Mortgage Broker School Texas
0 Apr On Cash Advance
0 Down Home Loans
Separation Anxiety Disorder In Child
Compare Second Mortgage Rate
London Drug Canada
Nys Bankruptcy Law
Arts Culinary Michigan School
How To Make Video Code For Myspace
Ice Age Trigger Global Warming
Performance Muffler
Icecream
Angeles Apartment Ca In Los Rent
Baby Costume Gap
Adult Gross Halloween Recipe
Radio Shack Locator
Fitness Usa Supercenters
Fitness Model Workout
2008 Presidential Prediction
Mesothelioma Tests
1 2 3 Bath Kitchen
Handbook Oil Testing Well
House Building Plans
04 Answer Interview Job Question
Faucet Leak Supply Water
Cheapest Flight To Costa Rica
Dance Outfit Team
110 Car Complete Driving Emergency Guide Road Safe Staying Survive Them
Large Dog Bed
Arizona Trails
Oj Simson
Free Sample Retirement Letter
Avon Bottle Collectible Perfume
Online Vegetarian Recipes
Easy Christmas Cookie
Automotive Car
Boy Blue
Animal Farm Preschool
Real15
Champagne Chocolate
Targus Rg0322
Wilson Pro Staff Tennis Shoes
Chevys Restaurant Coupon
Roofing And Siding Contractor
2006 Award Europe Mtv Music Performer
0 Degree Sleeping Bag
Metropolitan Grill Seattle
Hunter Publishing


0 Responses to “Great Technical Writing: User Document Headings Should Be Guideposts, Not Advertisements”

Leave a Reply

      Convert to boldConvert to italicConvert to link

 


About me

Previous posts

Archives

Links


ATOM 0.3