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.
I would go with your first option. It's not cool to leave those things
undocumented. IMO, that looks like an error and makes me wonder about what
else is missing from the docs.
On Thu, Aug 5, 2010 at 9:35 AM, McLauchlan, Kevin <
Kevin -dot- McLauchlan -at- safenet-inc -dot- com> wrote:
> 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.
> My default reaction is to just stick arrows and letters
> on such items in the diagram, and then in the call-out
> list say (for items "e" and "f" in this case):
> a. ....framistan
> b. ....doohickey
> c. ....thingamajig
> d. .... network ports 0 and 1
> e. (Not used in this application - do not connect)
> f. (Not used in this application - do not connect)
> g. Hot-swap power supply 1
> h. Hot-swap power supply 2
> i. ..........
> There's no danger of loss or damage. If you connect something
> to those ports, simply nothing useful happens, and whatever
> you thought might happen... probably doesn't, not even a bad
> smell... probably.
> Is it cool to have curious little items like that simply
> ignored? Not acknowledged in the docs at all? (I vote "no"
> on that, but I would be happy to learn counter-arguments.)
> Kevin McLauchlan
> Senior Technical Writer
> SafeNet, Inc.
> <bumpf-starts-here>The information contained in this electronic mail
> may be privileged and confidential, and therefore, protected
> from disclosure. If you have received this communication in
> error, please notify us immediately by replying to this
> message and deleting it from your computer without copying
> or disclosing it.
> 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.
> 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 sjd1201 -at- gmail -dot- com -dot-
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwr-l.com/ for more resources and info.
> Please move off-topic discussions to the Chat list, at:
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-