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.
Subject:RE: What to use: Buttons, Function Keys, or Both? From:"John Posada" <JPosada -at- isogon -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 2 Jun 2004 12:05:28 -0400
It's not a hard and fast rule, I try to give an alternate way whenever I
can. However, I don't if it seems odd based on context, and I'm the
judge of that.
I find the best time is in an introductory paragraph at the start of a
section. The worst place is in the middle of a series of procedure
steps.
In fact, I'm looking at a paragraph in front of me now: it goes:
"You can start a new XX by clicking the XX button at the top of the XX,
from the menu File -> New, or by pressing CTRL+N from your keyboard."
The rest of the topic then uses only one way.
John Posada
Senior Technical Writer
Isogon Corporation http://www.isogon.com
"Realizing Your Business Goals
Through Software Asset Management"
-----Original Message-----
Subject: What to use: Buttons, Function Keys, or Both?
When documenting buttons on a GUI, is it also recommended to also
include the function keys command (e.g. F1 - F12)?
I am documenting a procedure for SAP and the trainer wants me to include
the function keys for almost all buttons. I'm just curious if this is a
standard or not.
SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo
>From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more. http://www.doctohelp.com
---
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- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
