[mythtv-users] Myth Documentation, was: Please shut up!
Jay R. Ashworth
jra at baylink.com
Mon Jan 29 17:22:21 UTC 2007
On Mon, Jan 29, 2007 at 11:54:16AM -0500, Rod Smith wrote:
> As the point of a wiki is to provide useful information to readers, I
> personally consider option #2 undesirable verging on unacceptable. That
> leaves #1 -- individual entries *MUST* be updated *IMMEDIATELY* upon release
> of a new version, at least to flag their newly-uncurrent status, to prevent
> reader confusion. Of course, they should eventually be updated to reflect any
> changes to the software, too, but that's true whether or not the entries were
> version-flagged to begin with.
But what you *really* want is #3:
> It's much simpler and clearer to include version information with each wiki
> entry when its made. That should minimize confusion or uncertainty about the
> relevance of the information to any given version of the software, or at
> least alert readers to the fact that the wiki doesn't cover a given topic
> with respect to whatever software they're running, if that's the case.
"Tag on addition". And of course, you're right.
Of course, in the interim, people should be tagging everything they
touch about which they're sure what it applies to. But I don't set
policy anymore... who's doing that these days? ;-)
Jay R. Ashworth jra at baylink.com
Designer Baylink RFC 2100
Ashworth & Associates The Things I Think '87 e24
St Petersburg FL USA http://baylink.pitas.com +1 727 647 1274
More information about the mythtv-users