From Paul Jones' weblog today, there's a posting that more and more developers should live by - Document Your Project Already!
Of course, everyone out there that's dealt with public/shared code knows this feeling all too well. You have to spend an hour after you've got the code simply going through it, seeing what does what, and going from there. According to Paul, it should include: from-scratch written-for-the-newbie plain prose documentation on what to do, how to do it, why to do it like that, and (most especially) what the shortcomings and workarounds are.
And remember: Documentation of public PHP code is the responsibilty of the original coder. Not the users, not some third-party angel, not "the community" ... the original coder.




