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:"Jones, Donna" <DJones -at- zebra -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 2 Jun 2004 11:04:32 -0500
I vaguely remember this or a similar topic being discussed a month or two
ago. People agreed that knowing how the function keys work is a good thing
(what good are they if they're not documented somewhere?). I could be wrong,
but I think the consensus was to put the function keys in their own help
page or appendix or to put them into a separate column of a table if you use
headings like this:
BUTTON DESCRIPTION/ACTION FUNCTION KEY
This is much less clunky than trying to include both the button and the
function key in an instruction ("To exit, click OK or press F1.").
-----Original Message-----
From: Allen, Emily [mailto:emily -dot- allen -at- teldta -dot- com]
Sent: Wednesday, June 02, 2004 10:52 AM
To: TECHWR-L
Subject: What to use: Buttons, Function Keys, or Both?
Hi,
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.
Thanks!
Emily
- CONFIDENTIAL -
This email and any files transmitted with it are confidential, and may also
be legally privileged. If you are not the intended recipient, you may not
review, use, copy, or distribute this message. If you receive this email in
error, please notify the sender immediately by reply email and then delete
this email.
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.