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:Matching the CAPITALIZATION of the interface From:Steven Jong <SteveFJong -at- comcast -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 18 Feb 2005 07:59:03 -0500
Before I launch into a rant at work, I would like to check with the
list on a matter of best practice.
We are documenting a product with hundreds of named, permanent data
objects that you can create and modify. The interface includes complex,
multi-tabbed forms for each class of object, often with labeled
sections on each tab. In the last major release of the product, the
company hired an outside consulting firm to redesign the forms. The
redesign included setting the form names and section labels in
uppercase. So, for example, let's say there's an Access object named
Write that you define and modify using a form titled "ACCESS Write"
(the form name is in uppercase on screen) and on the front tab there's
a section labeled "PARAMETERS" (the section label is in uppercase on
the form).
My question: In references to the forms or their sections, which of the
following is common practice?
(A) In the PARAMETERS section of the ACCESS form, select blah blah
blah...
OR
(B) In the Parameters section of the Access form, select blah blah
blah...
One side of this discussion is that you match the interface, and thus
(A) is best practice; in fact, not to do so is to editorialize that we
don't like the redesign. The other side is that (B) is quieter in text,
and that readers won't have any trouble translating what's written to
what's on screen.
I have a strong opinion on this matter, and there are hundreds of such
references in my book and thousands in the doc set hanging in the
balance. What do YOU think?
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
Doc-To-Help 7.5 Professional: New version with new features, improved performance and reliability, plus much more! Download your free trial today at www.componentone.com/techwrlfeb.
---
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.
