How is documenting hardware different from documenting software?; was, "Re: Is there a study on reading warnings, notes?"

Subject: How is documenting hardware different from documenting software?; was, "Re: Is there a study on reading warnings, notes?"
From: "Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com>
To: "Gene Kim-Eng" <techwr -at- genek -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 6 Nov 2008 10:56:38 -0800

I've documented some hardware, but for the most part, I have worked in
software. I sometimes think about moving into hardware/machinery
documentation, and Gene's comments got me to wondering what the
difference is between documenting software versus hardware/machinery.

Is the process much different?
Is the lifecycle of one generally longer or shorter than the other?
Does one generally entail better review processes than the other?
Is one generally more fun than the other?
Anything else?

Obviously, some answers will depend on personal disposition, but I'd
still like to hear what people have experienced.

Thanks in advance.

Leonard


-----Original Message-----
From: techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+leonard -dot- porrello=soleratec -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of Gene Kim-Eng
Sent: Thursday, November 06, 2008 10:42 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Is there a study on reading warnings, notes?

A partial list of my past products, both as an engineer and
a writer (I think I've mentioned some of these previously):

Helicopter rescue hoists
Handling and loading equipment for ICBMs
Semiconductor fabrication equipment (lethal chemicals, megavoltages,
lasers)
Mass spectrometer and chromatography instruments (more lasers)
DNA sequencers (still more lasers)
Architectural/industrial scanning equipment (surprise! lasers again)
Aircraft power management systems

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.
http://www.doctohelp.com

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
RE: Is there a study on reading warnings, notes?: From: Shannon Wade
RE: Is there a study on reading warnings, notes?: From: Leonard C. Porrello
RE: Is there a study on reading warnings, notes?: From: Shannon Wade
RE: Is there a study on reading warnings, notes?: From: Leonard C. Porrello
RE: Is there a study on reading warnings, notes?: From: Shannon Wade
Re: Is there a study on reading warnings, notes?: From: Deborah Hemstreet
RE: Is there a study on reading warnings, notes?: From: Shannon Wade
RE: Is there a study on reading warnings, notes?: From: Leonard C. Porrello
Re: Is there a study on reading warnings, notes?: From: Gene Kim-Eng

Previous by Author: RE: Is there a study on reading warnings, notes?
Next by Author: RE: How is documenting hardware different from documenting software?; was, "Re: Is there a study on reading warnings, notes?"
Previous by Thread: Re: Is there a study on reading warnings, notes?
Next by Thread: Re: How is documenting hardware different from documenting software?; was, "Re: Is there a study on reading warnings, notes?"


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


Sponsored Ads