Re: Documenting hardware interfaces

Subject: Re: Documenting hardware interfaces
From: "Michael West" <mbwest -at- bigpond -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 24 Oct 2008 07:31:49 +1100

> My background is primarily centered around software. I now find myself
> needing to define pieces of hardware, mainly the UI: buttons, keys,
> toggles, switches, cables, ports, and quite a few thingamabobs and
> doohickeys that I've never dreamt of in my philosophy.

If I were in that position, the first thing I'd do is go to the manufacturer
and supplier websites to find out what terms THEY use for these objects in
the marketplace. I would then use Google to find the extent to which that is
the common term, and then I would decide which term or terms are most
appropriate for my particular audience, based on observation of and
discussion with people who work in the field.

Mike West


ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -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 for more resources and info.

Please move off-topic discussions to the Chat list, at:

Previous by Author: Re: Documenting hardware interfaces
Next by Author: RE: Alternative directions in technical communications
Previous by Thread: RE: Documenting hardware interfaces
Next by Thread: Alternative directions in technical communications

What this post helpful? Share it with friends and colleagues:

Sponsored Ads