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 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!!
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! http://www.webworks.com/techwr-l
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 http://www.techwr-l.com/techwhirl/ for more resources and info.