RE: Software Text Incorrect

[jgarison -at- ide -dot- com]

The documentation is considered to be the design of the system, therefore,
if the software does not perform as described in the documentation, then
there is an error. The likelihood of error in the software is MUCH higher
than the likelihood of an error in the documentation. That said, I stand by
the decision to make the documentation correct. 

When they get around to fixing the bug, then the documentation will be
incorrect. 

However, since we here at IDe are involved in the design and development of
our products, misspellings rarely make it through review. Not that it
doesn't happen ...

I still want to be able to point to the books (well, help files actually)
and say with confidence that they are correct and represent the planned
operation of the product.

John



-----Original Message-----
From: Kelly Werner [mailto:kwerner -at- eaglesoft -dot- net]
Sent: Wednesday, November 07, 2001 2:19 PM
To: TECHWR-L
Subject: RE: Software Text Incorrect


John Garison writes
"IMHO, a misspelling is a bug, and I don't document bugs. I would correct it
in the documentation."

However, if the software is not to be corrected, I would make the
documentation match the program. In the end it would be YOU ( the
documentation ) that looked incorrect to the end user. Having 'done time' on
help desk, I can assure you that the end user notices mismatched words more
often than misspelled or misused words.

Cheers,
Kelly Werner
Technical Writer

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Be a published author!  iUniverse gives you: a high-quality paperback, a
custom cover design, and distribution to 25,00 retailers.  Join our almost
10,000 published authors today. http://www.iuniverse.com/media/techwr

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot-  Visit 
http://www.raycomm.com/techwhirl/ for more resources and info.