Daniel Hardy

Due to my Uber nerd status I probably review more documentation than most people.   I have a sick and twisted love of teaching my self new things which means I spend a lot of time reading obscure documentation.

Lately I have been spending a lot of time reading documentation for PHP, MySQL, JQuery, and Adobe AIR.  As I have been pouring over pages and pages of information I have started thinking about documentation’s place in the user experience.

Documentation’s impact on the user experience is often not directly talked about.  When asked, most UX practitioners would probably agree that it is part of the almighty user experience but if pushed further I think you might find that they rarely consider it (assuming they aren’t directly responsible for it).

The problem with this is that when a user turns to documentation for help, the experience has already been compromised.  This means that documentation is the last line of defense, a last opportunity to save the user experience and ultimately save a customer.

So what makes good documentation? Unfortunately I am not qualified to give a complete answer of what “good” documentation is.  I do know that documentation that is incorrect is probably the worst thing that can happen.  If a user is told to do something it better work for them.  If there is a possibility that it won’t work, they should be notified of why it won’t work and more importantly how they can tell if they fall into the “won’t work” category.

One feature I have found to be “good” is user comments presented with the article.  Often I read an article and miss some key component or have questions of how it applies to my situation.  If it is a popular documentation center it isn’t uncommon to find someone else answering my question somewhere in the comments.  A great example of this can be found all over the PHP documentation.

There is a lot more to documentation than meets the eye and its impact on the user expeirence is probably more substantial than most UX practitioners believe.  I have heard things like “If I do my job they(documentation team) will be out of a job”.  This is a foolish and dangerous view.  Even in the best scenario some users will need to read about it to understand it.