Joel Kleier's Electric Froth

up

Documentation

by Joel Kleier on 2013-08-20


I think there are, primarily, four broad categories that developers fit into when they become users of a library or framework:

  1. Beginner
  2. Intermediate
  3. Experienced
  4. 'Master'

These four areas broadly define some important aspects that any set of documentation really needs to hit on to be considered "good."

Beginner's are developers who've bought into using a library or framework, and now need some direction in how to use it. Tutorials, walk-throughs, pod/video-casts, 'hello world' apps, etc, are all tools that the beginner will find really useful. Documentation at this level really needs to be about guiding the individual in the uses of the library/framework without letting them bump into any sharp corners.

Intermediate level developers are those who've read the beginner material, or are at least familiar with the system in question. The training wheels are off, and these individuals need documentation that covers the most common pitfalls and some more of the common, but, perhaps, complex, configuration situations that come up. They also need comprehensive documentation on the API or framework itself, so when a situation comes up that isn't documented directly, they have the tools to figure out some of the simpler pitfalls.

Experienced level developers are those who've bumped into their fair share of sharp corners, and have had to really dig into the framework or API documentation. They may have also dug into the code to figure out their problems. These developers/users might also have committed a fix or two.

'Master' level developers are those who really understand the ins-and-outs of the system in question. They may not be familiar with every aspect of the code, but they're familiar enough that they have an intuition about problems that arise, and how to get around them. If the problem can't be worked around, these are the people that really know how the system should be altered to accommodate their situation.

Now, of course this is an arbitrary categorization, and many times people that would fit into one category could also fit in another.

Also, this whole idea presumes that developers are users of a piece of software first. To get a task done, they don't immediately want to jump into every library or framework and become intimately familiar with how it's coded up. Sometimes getting shit done means taking a leap of faith that they can depend on some library or framework to do what it advertises, without getting into the sticky details.

With that in mind, working with Plone, Django, Pyramid/Pylons, and a host of other Python related libraries and frameworks tends to frustrate the crap out of me, at least in terms of their documentation strategies.

On the one hand, there is lots and lots of documentation out there, but often times it's not really all that 'good' (for my definition of good, anyway). Many times these pieces of software have decent beginner documentation -- plenty of 'hello world' examples, and, usually, enough descriptive text to explain what the example is all about. Often times they have some sort of API documentation, which is usually auto-generated, and in varing states of usefulness.

On the other hand, they tend to lack in more of the intermediate-level documentation -- documentation that more clearly explains some of the concepts of the advanced features, and gives some solutions to common situations/pitfalls. While they do often have API documentation, the API documentation often has gaps because it's someone didn't actually comment the code (or, maybe, comment it very well), because, you know, it's obvious.

Often, for any kind of documentation other than the very basic 'hello world' example(s), it's "visit IRC", "visit the list", or "read the code."

Yes, having a way to communicate with the community around a piece of software can be an awesome thing to behold! It can be very useful... except when people keep coming and asking the same general things. Then the people that tend to stick around and help either don't continue to stick around, or stop helping people with the same questions they've answered many times before. Then it becomes 'search the archives', 'RTFM, stupid', or a question just goes unanswered.

Certainly, this doesn't always happen, but it happens a lot more than maybe it should. I feel like this is the result of a lack 'good' documentation.

There are two more things that irrationally irritate me when it comes to documentation:

First, pointing to another projects documentation, but not explaining how the current project uses it! I mean, come on. Just saying that a piece of software is based off another doesn't mean that it was integrated and is used exactly like the original project intends and documents it.

Second, documentation location(s) -- seriously, don't have more than one location where you're documentation is accessed from. And while we're at it, when you have a lot of different versions of your applications, make sure google, etc, aren't pointing to old documentation versions. If they do, make sure there's an updated version of the documentation that is linked to from the old documentation.

I'm sure there's a lot more that I could complain about in regards to documentation, but this post is already long enough.

I guess I leave my opinions for some hand-wavy solutions: