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.
Missy Phillips wrote:
> Hi Everyone, I'm new to the list, and I'm creating a user guide. What would
> I put in the Document Conventions section of the document? Can anyone help
> me with that?
Usually, this section explains the design and wording conventions
that you use. If you use different fonts for different purposes,
such as a monospaced font for a command, you might mention it
with an example. If you use "select" for choosing something with
a mouse, and "press" for typing, you might mention that.
As an aside, I'd like to mention that I always try to keep this
section as short as possible. That means I also try to use as few
design and wording conventions as possible. Maybe I'm just a lazy
reader, but, if I'm any example, I find too many conventions hard
to remember. Deciphering an entire legion of conventions is worth
than squinting at the symbols in a Michelin guide.
Bruce Byfield, Outlaw Communications
Contributing Editor, Maximum Linux
bbyfield -at- axionet -dot- com | Tel: 604.421.7189
"But why ask questions now, and yet there's no denying
There's emptiness in heart and soul
When someone's been deceived."
- Eileen McGann, "Westminster Bridge"