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.
Kevin asked:
>> In documenting a hardware product that uses a chassis
>> common to several other of your company's products,
>> how do you refer to unused physical features like (say)
>> an electrically live USB port or a specialty port that
>> doesn't have a function in the current product.
I use something like your "Not used in this application - do not
connect" option.
The most common solution is simply "Reserved," but that invites
questions such as "Reserved for whom?" "For what?" "Until When?" "Does
that mean I can plug it into the power mains and perhaps make it run
faster?"
To meet electrical safety standards (Low Voltage Directive 2006/95/EC,
UL, etc.) a common requirement is to clearly identify and document the
proper use of ALL electrical connectors, so don't ignore them
completely.
--
Paul Goble
www.pgcommunication.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Gain access to everything you need to create and publish information
through multiple channels. Your choice of authoring (and import)
formats with virtually any output. Try Doc-To-Help free for 30-days. http://www.doctohelp.com/
LavaCon 2010 in San Diego Sept 29 - Oct 2 is now open for registration.
Use referral code TECHWR-L for $50 off conference tuition!
See program at: http://lavacon.org/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
