On 11-11-27 01:18 AM, Gene Wirchenko wrote:
On Fri, 25 Nov 2011 22:04:04 -0500, Arne Vajh?j<arne@vajhoej.dk>
wrote:
On 11/22/2011 6:57 PM, Arved Sandstrom wrote:
Most of the diagrams I draw, I and a few others _are_ the intended
audience. We're just brainstorming on whiteboard or paper.
The guys that will maintain the code in 10 years may appreciate
it if they get a copy of some of that stuff that explains why
certain code was designed in a certain way.
I put comments like that in my code.
Me also. In my experience requirements documents and design documents
are on borrowed time as soon as their related implementation goes into
production. Depending on the organization you may actually be able to
find them for a year or two, but nobody will be updating them to reflect
maintenance work. And 5 or 10 years after go-live your odds of finding
*any* original requirements or design docs are not good, regardless of
whether you use a version control system or an ECMS to initially store them.
The only thing that stays with the code - reliably - *is* the code,
including comments.