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.
RE: numbering chapter, section and susbsection headings
Subject:RE: numbering chapter, section and susbsection headings From:John Posada <JPosada -at- book -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 20 Nov 2002 12:55:38 -0500
Which reminds me...
How do you address the situation where you are instructing someone to enter
a number, maybe a license number, that resembles the following:
214100000000000009
I don't know about you young whippersnappers, but I just turned 49 on Monday
and my eyesight isn't what it used to be. if I seer this in documentation, I
take the page to a photocopier, enlarge it about 400% and mark off each zero
as I count.
How do would you handle this in the documentation you write?
John Posada
Senior Technical Writer
Barnes&Noble.com
jposada -at- book -dot- com
212-414-6656
"Available for next gig Feb 01, 2003"
-----Original Message-----
From: kcronin -at- daleen -dot- com [mailto:kcronin -at- daleen -dot- com]
Sent: Wednesday, November 20, 2002 12:44 PM
To: TECHWR-L
Subject: Re: numbering chapter, section and susbsection headings
> Does numbering chapter, section and susbsection headings encumber rather
> than signpoint navigation through bigger manuals? I think page numbers are
> sufficient for indicative purposes.
I've seen numbered headings taken to ridiculous extremes, with six or
seven levels of headings. Telling somebody to refer to section
1.2.1.1.4.1.2 is not usually helpful.
But the bottom line is, ANYTHING that helps readers FIND the information
they want is a good thing. So make sure you put some thought into the text
and structure of your headings (in terms of what shows up in the TOC),
whether you number the headings or not.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Check out SnagIt - The Screen Capture Standard!
Download a free 30-day trial from http://www.techsmith.com/rdr/txt/twr
Find out what all the other tech writers, including Dan, already know!
Order RoboHelp X3 in November and receive $100 mail in rebate, FREE WebHelp
Merge Module and the new RoboPDF - add powerful PDF output functionality
to RoboHelp X3. Order online today at http://www.ehelp.com/techwr-l
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
