RE: How important is up-to-date documentation? Was: RE: Gnaargh! Or, I Am Not Psychic

Subject: RE: How important is up-to-date documentation? Was: RE: Gnaargh! Or, I Am Not Psychic
From: "Joe Malin" <jmalin -at- tuvox -dot- com>
To: "Martinek, Carla" <CMartinek -at- zebra -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 13 Sep 2006 10:38:08 -0700

I've been a software engineer, and I still do lots of programming-type
work for my small startup company. I *constantly* run into poor
documentation. Any SW engineer that uses open source SW *must* be
running into poor documentation. Any engineer that uses a new product,
hard or soft, *must* be running into poor documentation.

If you see an engineer giving you "attitude" about docs, pity him or
her. They have a very poor memory! Then hand them your copy of
FrameMaker and dare them to create a document with it!

Documentation is crucial. To heck with "defending" product
documentation. We're the most important part of the company!

Joe Malin
Technical Writer
(408)625-1623
jmalin -at- tuvox -dot- com
www.tuvox.com
The views expressed in this document are those of the sender, and do not
necessarily reflect those of TuVox, Inc.

-----Original Message-----
From: techwr-l-bounces+jmalin=tuvox -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+jmalin=tuvox -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Martinek, Carla
Sent: Wednesday, September 13, 2006 9:06 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: How important is up-to-date documentation? Was: RE: Gnaargh!
Or,I Am Not Psychic

Below is the text of an email someone just posted on an editors list I'm
on. If you ever start to think that up-to-date documentation isn't
important, read on. Or better yet, share it with those in your company
who think that the docs just don't matter.

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

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


Previous by Author: RE: Converting HTML docs to PDFs
Next by Author: RE: Gnaargh! Or, I Am Not Psychic
Previous by Thread: RE: Comair Crash
Next by Thread: How would you handle this?


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


Sponsored Ads