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 have found that the example 1. below works best.
In the beginning/introduction of the document, spell out your conventions,
with examples.
Also...
Consider this: ALWAYS make the keyboard references BOLD and all CAPS.
The key references always standout in the document text.
This has worked well in the documentation that I have done while in an
engineering
(hardware/software) environment where the ultimate audience is 'unknown'.
And the
keyboard they (the user) use may be different than the one that I was using
during my documentation phase.
Harry M. Bacheler, Jr.
Consultant
VGS, Inc.
"The thoughts, ideas, and opinions expressed in my portion
of this email are mine and mine alone. They are not the
thoughts, ideas, and/or opinions of any past, present, or
future employers, or any group that I might belong to."
> -----Original Message-----
> From: bounce-techwr-l-20951 -at- lists -dot- raycomm -dot- com
> [mailto:bounce-techwr-l-20951 -at- lists -dot- raycomm -dot- com]On Behalf Of Karen Neeb
> Sent: Wednesday, 02 February, 2000 02:25 PM
> To: TECHWR-L
> Subject: Mac/Window button names
>... snip ...
>
> 1. Click the OK/Save button.
>
> 1. Click the OK (Save) button.
>
> Anyone have any other suggestions?
>
> Please cc me as I subscribe to digest.
>
> Thanks,
> Karen Neeb
> Kneeb -at- winnebago -dot- com <mailto:Kneeb -at- winnebago -dot- com>
> Sagebrush Corporation
>
>
