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: Writing Conventions From:Geoff Bradbury <bradg -at- INTEXT -dot- CPSG -dot- COM -dot- AU> Date:Wed, 1 Nov 1995 08:30:41 +1100
At 18:07 30/10/95 EST, you wrote:
> I am currently assisting in writing an Installation Guide, and have run
> into some problems with writing conventions. What conventions should I
> use to denote the following types of information (information enclosed by
> 1. Directories / Subdirectories
> Example: " Expanding the tar file will create a subdirectory
> 2. Script names
> Example: " Make sure that Oracle scripts *coraenv* and *oraenv*
> were copied.
> 3. Attributes
> Example: "If this file does not exist, create it with owner *oracle*
> and group *dba*.
At 8:18 1/11/95 AEST, I wrote:
Good to see the recent flamewars haven't scared all the students away!
There aren't any hard-and-fast rules about the conventions in which you're
interested. From my point, consistency is the priority. You could simply
italicize the relevant items. Or, you could italicize items 2 and 3, but
format item 1 in a contrasting face. Arial 10pt, for example (assuming your
body text is in something like Times 12pt). I'd steer clear of bolding,
underlining or excessive formats: they quickly clutter the page and break
your readers' flow.
Whatever convention you settle on make sure you document it at the front of
your publication. I always include a small section entitled "Conventions
used in this publication" in the Preface.
Hope this helps.
Geoff Bradbury - Technical Writer for InTEXT Systems
"Makers of extraordinarily fine text storage, retrieval, routing & analysis