comment on

Excellent thoughts.

Another, often-overlooked source of “documentation” is the change-history in the version control system, and any defect-reporting system records that you may have. (And you do have them and you do use them, don't you?... Ahh, yes. Of course you do. Of course.)

When you’re fixing a bug that was reported in the defect tracking system, record the defect-number in the comment. When you check-in the change, update the defect record to show it. This lets you perceive exactly what has changed in a module over time, and why.

This is a “dynamic” form of information, analogous to the “running log” that was routinely kept in the engine-room, or the “captain’s log” (“Stardate 4523.3 ...”) that was kept on the bridge.

Bonus Question: what happened on that stardate? Extra Vulcan-points if you don’t have to Google it...

In reply to Re^2: On comments by sundialsvc4
in thread On comments by pemungkah

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, 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, 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:
	&		`&`
	<		`<`
	>		`>`
	[		`[`
	]		`]`

Link using PerlMonks shortcuts! What shortcuts can I use for linking?

See Writeup Formatting Tips and other pages linked from there for more info.


Think about Loose Coupling
	PerlMonks