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:Format of GUI element names From:Steve Shepard <STEVES -at- YARDI -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 10 Nov 2000 11:13:41 -0800
I was wondering what style guidelines are being used out there when
identifying the names of interface elements. When you write, "Click the Save
button." Do you set off "Save" somehow? Do you make it bold, italics,
surround it with square brackets as in [Save], etc.?
I know many people set them off some how so it is easy to identify the fact
they are interface elements, but coming from a design background, I find a
page of scattered bold words to be more visually confusing than helpful.
The reason I bring this up is we have acquired another company and their
documentation puts these elements in square brackets (which I find
particularly distasteful from a design perspective) and of course we now
have a small controversy on our hands.
Any thoughts?
_________________________________
Steven Shepard
Manager, Documentation Group
Yardi Systems, Inc.
819 Reddick Avenue
Santa Barbara, CA 93103
805/966-3822
steves -at- yardi -dot- com
www.yardi.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by SOLUTIONS, Conferences and Seminars for Communicators
Publications Management Clinic, TECH*COMM 2001 Conference, and more http://www.SolutionsEvents.com or 800-448-4230
---
You are currently subscribed to techwr-l as: archive -at- raycomm -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.
