RE: Documenting hardware interfaces

Subject: RE: Documenting hardware interfaces
From: "Al Geist" <al -dot- geist -at- geistassociates -dot- com>
To: "'Michael West'" <mbwest -at- bigpond -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 23 Oct 2008 16:30:14 -0400

I'd like to add to Michael's posting that never, ever ask the reader to "hit
the Enter (or Return) key." Trust me, some will follow your instructions
literally. AND...never assume the reader has a clue what control or
component you are talking about. Show them with illustrations or photographs
if possible.

Al Geist
Technical Communicator, Help, Web Design, Video, Photography
Office/Msg: 802-872-9190
Cell: 802-578-3964
E-mail: al -dot- geist -at- geistassociates -dot- com
See Also:
Fine Art Photography

"...I walked to work, quit my job, and kept walking. Better to be a pilgrim
without a destination, I figured, than to cross the wrong threshold each
day." (Sy Safransky)

-----Original Message-----
From: techwr-l-bounces+al -dot- geist=geistassociates -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+al -dot- geist=geistassociates -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of Michael West
Sent: Thursday, October 23, 2008 4:14 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Documenting hardware interfaces

> Can anyone point me to a good resource for naming the parts of
> equipment, with a medical slant if possible (but maybe not necessarily)?

For many years IBM has published an excellent dictionary of computing.
There's also the
Wikipedia:Free On-line Dictionary of Computing for starters, and a little
Googling will bring you loads of other resources.

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:

Re: Documenting hardware interfaces: From: Michael West

Previous by Author: RE: What Program Do You Use for Software Documentation?
Next by Author: RE: Dori Green
Previous by Thread: Re: Documenting hardware interfaces
Next by Thread: Re: Documenting hardware interfaces

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

Sponsored Ads