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:Writing Conventions From:jennifer chiki <jennifer_chiki -at- BURLINGTON -dot- MARCAM -dot- COM> Date:Mon, 30 Oct 1995 18:07:02 EST
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
asterisks):
1. Directories / Subdirectories
Example: " Expanding the tar file will create a subdirectory
*mcinstal*.
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*.
I would greatly appreciate any ideas,
Jennifer Chiki.
p.s. I'm a student!
_________________________________
jennifer -dot- chiki -at- marcam -dot- com
Marcam Canada Corporation
