× The internal search function is temporarily non-functional. The current search engine is no longer viable and we are researching alternatives.
As a stop gap measure, we are using Google's custom search engine service.
If you know of an easy to use, open source, search engine ... please contact support@midrange.com.



By comparison, in many of those cases, the procedure itself will have
minimal documentation, since any developer who has to maintain it should
know what they're >doing before they start messing with the code.

FWIW this is a dangerous attitude, in my opinion anyway. It presumes
someone thinks like you do and can understand your logic quickly. This
may not be true. Comments in the code, even to the point of
pseudo-code, can be of great benefit to those having to understand why
you did something the way you did.

I concur. It has been my experience that the only documentation that
really survives (and is meaningful) is what the developer puts in the
code.

Written documentation disappears and/or is very seldom passed along or
looked at. If you can help the next developer understand what you are
doing, you can cut his work in half and improve the results of his work
also.

The same goes for user documentation, if it not part of the software,
the user will most likely not see it. User documentation needs to be
written into the software and help screens.

Thanks, Chuck





As an Amazon Associate we earn from qualifying purchases.

This thread ...

Follow-Ups:

Follow On AppleNews
Return to Archive home page | Return to MIDRANGE.COM home page

This mailing list archive is Copyright 1997-2024 by midrange.com and David Gibbs as a compilation work. Use of the archive is restricted to research of a business or technical nature. Any other uses are prohibited. Full details are available on our policy page. If you have questions about this, please contact [javascript protected email address].

Operating expenses for this site are earned using the Amazon Associate program and Google Adsense.