RE: Document Conventions

Subject: RE: Document Conventions
From: "Bowen, Marianne" <Marianne -dot- Bowen -at- Nextel -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 19 Sep 2000 12:31:24 -0400

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.


Marianne Bowen
Sr. Technical Writer
Nextel Communications, Inc.
IT - Engineering Systems
Phone: 703-552-7018
iDEN: 703-930-4355
Direct Connect: 11365

-----Original Message-----
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.

Previous by Author: Re: Table "continuation" field in Word...
Next by Author: help for a java application
Previous by Thread: RE: Document Conventions
Next by Thread: RE: Document Conventions

What this post helpful? Share it with friends and colleagues:

Sponsored Ads

Sponsored Ads