note
BrowserUk
<blockquote><i></i></blockquote>
<p>If (module/unit) documentation only ever consisted of interface specifications, then (perhaps), POD would be fine. But, all too frequently, it also has to contain a mountain of stuff that is essentially unrelated to the code.
<p>Whether it's algorithm explainations, or market research, or comparative studies or whatever else might be useful or required by the <i>users</i> of a module. But often this stuff is of no consequence to the programmer maintaining the module.
<p>To conflate user documentation with programmer documentation is a bad idea. Even if the modules <i>users</i> are also programmers at the next level up, mixing the two types of documentation together means that it serves neither group well.
<P>There's also the problem that purely textual changes, from typos to reattributions to rephrasing of prose can trigger RCS trails associated with the code that shouldn't be. Documentation also belongs in the RCS system, but as independant entities to the code, so that documentation changes do not affect the revision history of the code and vice versa.
<div class="pmsig"><div class="pmsig-171588">
<hr />
<font size=1 >
<div>Examine what is said, not who speaks -- Silence betokens consent -- Love the truth but pardon error.</div>
<div>"Science is about questioning the status quo. Questioning authority". </div>
<div>In the absence of evidence, opinion is indistinguishable from prejudice.</div>
<div>[http://news.bbc.co.uk/1/hi/education/6202877.stm|"Too many [] have been sedated by an oppressive environment of political correctness and risk aversion."]</div>
</font>
</div></div>
614216
614415