Although reasonable people can differ on some of the finer points, this response hits the nail on the head and draws out a lot of the contentious issues ... issues that strangely draw the ire and resistance of many for some strange reason.

case in point: the 'large environment metadata' sample you provided is almost (if not entirely) optimal for the type of concise, accessible specification one would hope to see in a 'professional' environment. (plain, forward-looking, demonstrates competence, provides useful audit trail)

Yet, I would bet money that few if *none* of you in the larger environments (I'm not naming names here) have *ever* inherited a project that was completely and coherently covered in such a straightforward manner. This is especially so for projects consisting of largish teams with oversight from multiple (departments/camps/competencies); *specifically* the context where this sort of approach is most cost-effective and beneficial.

Someone once said, in technology, that the best approach is (usually) (always) the one that never sees the light of day.

In reply to Re^2: The sourcecode *is* the documentation, isn't it? by dimar
in thread The sourcecode *is* the documentation, isn't it? by dimar

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.