Tuesday, 15 May 2007

Bad documentation

What is it that makes documentation "bad"?

(1) When documentation has been written only for people who already know about the subject of the documentation, and provides no reference path for where to go prior to it.

(2) When documentation has been written with an audience in mind who are different than the audience that the documentation is provided to.