Jacobian on Writing Good Documentation

November 10th, 2009

Jacob Kaplan-Moss aka Jacobian, Co-Benevolent-Dictator-for-Life of Django, has been on a killing spree with his recent blog posts. Generally when I find a good link that I think other people should read, I just hit the "share" button in Google Reader, but I thought that this was good enough to warrant a little note and an official tip of the hat. His latest post is on the documentation of open source projects, and he promises a follow up.

So what makes this post so good? Well, it isn't the incredible narration (not to say that it is written poorly, far from it!) but the fact that Jacobian really knows what he is talking about here. One of, if not the, biggest contributing factors to Django's success and claim to Most Popular Python Web Framework is the incredible documentation. The chance that I will use your library/module/helper is exponentially greater if there is at least any documentation. I know that I'm not an outlier when I make that statement.

Enough babble from me, get it straight from the source: http://jacobian.org/writing/good-documentation/

« Previous Entry

Next Entry »