Subject: Conventions
From: Suzette Leeming <suzette -dot- leeming -at- gmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 27 Jul 2005 14:07:18 -0400

I am in the process of setting up documentation conventions, and I'm
questioning my current conventions and can't find my MS Manual of

So I thought I would ask the experts....

How do you refer to/depict each of the following:

- The name/title of a window (The Main Widget Administration window)
- A key on the keyboard (i.e., press Enter, or F1, etc.) (I used to
put in square brackets and bold)
- A button in the application (i.e., click Continue)
- System and Error messages (I usually use Courier)
- Text the user needs to type (Type: /u/public)

I know the important thing is consistency and I AM consistent, but
since I'm just starting to set this up, I thought I would see what
type of conventions others used.

If this type of question bothers you, please feel free to delete this
message without responding. Thanks in advance to those who will take a
moment to answer!!

Suzette Leeming
Stouffville, Ontario

If we'd stop trying to be happy we could have a pretty good time.
- Edith Wharton


Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today!

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release.

You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: Re: OT: Declining a copyediting test
Next by Author: Re: Certification--a new concept. Discuss.
Previous by Thread: Addendum to previous query
Next by Thread: RE: Conventions

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

Sponsored Ads