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.
> From: Susan Arbing[SMTP:Sarbing -at- ITCCanada -dot- com]
>
> I'm in the midst of a discussing about bolding menu commands in
> procedures.
>
> I am writing a manual for a software program. My QA person is suggesting
> that I bold the commands. For example, in the step "Click Save" save
> would be bolded.
I'm not inclined toward bolding. I think bolding is more useful
> intraining materials and tutorials where a user is being introduced to a
> product and needs a lot of emphasis and reinforcement.
In reading responses to this, it seems the primary focus has been lost on
Techwriter vs. developer and who is going to 'call the shots' on
documentation.
The primary focus is what will help the user of the document. My opinion is
bolding commands is always useful. A more experienced user does not have to
read all text in order to find useful information. They can scan for the
bolded items and get on track. A less experienced user knows a bolded item
is a necessary command in the procedure. Anyhow, the driver for any
documentation is not the writer or the developer. It is the end-user and
what will facilitate their use of your documentation.
Alice Kirk
QA Manager
United Recovery Systems, Inc.
akirk -at- ursi -dot- com
