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.
I personally use document conventions a lot. I see no reason to make the
users figure out conventions themselves. It is very simple to create a
standard for document conventions and utilize that standard with every
project. When I read a user guide I always look at the conventions section ,
and I believe that most users do. No, I don't believe that my use of a
conventions section requires me to redesign my documents, so far I always
had very positive feedback on my documentation. I try to do usability
testing for my documents wherever feasible, and I know that the document
conventions add to the usability of a document.
Sr. Technical Writer
Nextel Communications, Inc.
IT - Engineering Systems
Direct Connect: 11365
From: Sanjay Srikonda [mailto:SSrikonda -at- invlink -dot- com]
Sent: Tuesday, September 19, 2000 11:34 AM
Subject: RE: Document Conventions
so, is the general consensus that document conventions are good or bad? I'm
thinking about including one in my main application help so that users can
better use the help. The only convention I'm using currently is including
text messages that are generated by the system in a Courier font as opposed
to the Arial font as in the rest of the help.