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

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

Virtually all my experience documenting software is
with software that operates or otherwise interfaces with
hardware. In that environment, the software tends to
be subject to the same schedules, processes and other
requirements as the hardware, especially so if the
only way you know the software is working correctly
is by testing it with the hardware.

My only experiences with software-only companies
have been one or two cases where we were doing
the hardware and buying the software from OEMs.
I still experience occaisional PTSD episodes about
them.

Gene Kim-Eng


----- Original Message -----
From: "Leonard C. Porrello" <Leonard -dot- Porrello -at- SoleraTec -dot- com>
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.

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

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


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
How is documenting hardware different from documenting software?; was, "Re: Is there a study on reading warnings, notes?": From: Leonard C. Porrello

Previous by Author: Re: Is there a study on reading warnings, notes?
Next by Author: Re: A dark take on Tech Writing...do you agree?
Previous by Thread: Re: How is documenting hardware different from documenting software?; was, "Re: Is there a study on reading warnings, notes?"
Next by Thread: RE: Is there a study on reading warnings, notes?


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


Sponsored Ads