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:To number or not to number? From:Matthew J Long <mjl100z -at- MAIL -dot- ODU -dot- EDU> Date:Wed, 11 Jun 1997 12:43:52 -0400
Thanks for all of the responses to my message regarding the different
"flavors" of an application and whether I should repeat information. It
has halped me make a decision in the document planning stage.
What I wonder now is whether or not I should use the technical manual
numbering format (##.##.##) for each of the sections. When considering
that my audience (my professors would be proud) consists of attorneys and
paralegals who have a relatively limited knowledge of computers, I decided
to write the manual for the lowest common denominator (no offense intended
to lawyers). In my own experience (little as it may be) I have found that
manual's written in a style like the IDG For Dummies series (which don't
use the technical manual numbering) seem pretty effective for a "lowest
common denominator" type audience.
What is the best way to go--numbers, or no numbers?
Personally I don't like the numbers for such a short manual as the one I
am doing(less than 100 pages). I think that they are effective for
semething that serves as a frequently used reference manual. But most
likely, if these attorneys and paralegals look at the manual at all, it
will probably be only once. The application for which I am writing is not
that difficult to understand.
I will probably disclude the numbers and just use different size headings
and subheadings to break everything up, but if anyone has a suggestion or
a comment, I would appreciate it.
Thanks.
////////////////////////////**************************************
Matthew J. Long
Technical Writer
mjl100z -at- mail -dot- odu -dot- edu
matt -dot- long -at- justice -dot- usdoj -dot- gov
-When you can't be eloquent, choose brevity!
********************************************************////////////
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
