Documentation

Oh the fun of documentation. It really is a pain in the ass but even more of a pain in the ass when you don’t do it. After spending half a day in a class on documentation and listening to one of the talks at LISA ’08 I really have the bug. There were a few ideas that stuck out to me…

  • Use Friday afternoon to document things. If you are documenting, things don’t get changed that will result in a phone call on the weekend.
  • Don’t just use the wiki to “document.” Use it as a place to discuss concepts and decisions so that the info is there when the question “Why” comes up. 
  • Document what needs to be documented… Sometimes it will document itself. And if it doesn’t, this way you remember to document it.
  • Use the wiki so that if the info is there it will be available for you anywhere.
  • Existence is the important part. Ugly documentation is better than no documentation.
Thanks goes out to SCaLE, LOPSA and Chris St. Pierre for the presentation. And of course to work for sending me.

Post a Comment

You must be logged in to post a comment.