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: How Would You From:Risa Nesselroth <risa -dot- nesselroth -at- AKS -dot- COM> Date:Thu, 28 Aug 1997 18:54:04 +0200
Better yet is a company-wide tracking system that numbers all bugs: each
bug is identified as #666 or whatever, so everyone knows which bug is being
discussed, and you get out of having to number paragraphs that don't want
to be numbered.
On 28-08-97 18:41:14 Robert Plamondon wrote:
>Bugs, bug fixes, and the like need to be identified individually
>so people can talk about them. Bugs and bug fixes are a constant
>source of telephone and e-mail conversation, and if you don't
>number them, it's very difficult to discuss them at all.
>Sure, you could use bullets or a sweeping, uninterrupted narrative,
>but this forces people to refer to "the second paragraph on page
>12." Even this doesn't work for HTML, which is unpaginated.
>Section numbers and numbered paragraphs make it a lot easier for
>people to discuss the material in a technical manual. Only if
>the reader is truly expected to deal with the information in
>isolation (as in very simple tutorials) should the signposts be
> -- Robert
>Robert Plamondon, High-Tech Technical Writing, Inc.
>36475 Norton Creek Road * Blodgett * Oregon * 97326
>robert -at- plamondon -dot- com * (541) 453-5841 * Fax: (541) 453-4139
> 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
Aladdin Knowledge Systems Ltd.
P.O. Box 11141, Tel Aviv 61110 Israel
Tel: +972 3 636-2222
Fax: +972 3 537-5796