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:Capitalizing...research need From:Erica Bruce <ericalbruce -at- gmail -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 25 Jan 2005 12:08:42 -0500
All-
I am a documentation specialist for a government contractor and in
charge of setting standards (b/c right now, we sort of do/sort of
don't have consistency amongst our contract documents.) One thing that
has come under some discussion with the writers as of late is as
follows....
For notating tab titles that appear on a computer screen, the current
standard is to capitalize the name. For example, if a tab window is
titled "Immigration Worksheet Tab," it's supposed to be displayed in
the document as "IMMIGRATION WORKSHEET TAB." Some good points have
been raised about how in the online world, caps indicate shouting,
which is true. Most other items that appear on the computer screen are
to be bolded in our documentation. Too much of any emphatic style is a
bad thing, that's true too, but how to differentiate?
Btw, our docs are designed for hardcopy. There is an online help
version that's basically the hardcopy transferred into Robohelp,
I have the opportunity to counter this capitalization-standard but
what I need is backup, like research or "many in the industry are
doing it this way" sort of material to move forward. With that in
mind, I thought I'd start here.
So...where do you stand on anything that's showing on a screen being
bolded? How are folks handling that distinction for the user if that's
not how you're doing it, and how did your group come to this decision?
At the very least, does anyone have handy some research that points to
one way over another?
Feel free to email me off-list and I'll compile and repost if that's
easier. Thanks.
____________________________________________
Erica L. Bruce
Technical Writer/Documentation Specialist II
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
Technical Communication Certificate online - Malaspina-University College, Canada. Online training in technical writing, software (FrameMaker, RoboHelp, Dreamweaver, Acrobat), document & web design, writing manuals, job search. www.pr.mala.bc.ca/tech_comm.htm for details.
---
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- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.