|Perl Monk, Perl Meditation|
Re^4: The problem of documenting complex modules.(Summation.)by afoken (Chancellor)
|on Jul 08, 2015 at 11:23 UTC||Need Help??|
Yes, it can get worse: "Community driven documentation", also known as a wiki:
Publish your code, cryptic, uncommented, undocumented. Have your users document it in a wiki. Release early, release often, just to make sure that the sparse information in the wiki is outdated just after it has been posted. Also make sure that the wiki only contains information about the current version, erase all information about older versions.
And to drive users of your code really, really mad: use a forum instead of a wiki, because you don't know how to set up a wiki. Allow every troll, every spammer, every script kiddie to post nonsense. Disable the search function, "coz it killz ma serva". Use robots.txt to keep Google away, because "it killz ma serva, too".
(I've not seen that for Perl modules, but for lots of other software.)
Today I will gladly share my knowledge and experience, for there are no sweeter words than "I told you so". ;-)