Defying Classification

by Malcolm Tredinnick

Topic: software/documentation

Mon 11 Jun 2007

The Importance Of Good Examples In Code Documentation

Posted at 21:01 +1000

Two articles (here and here) by Greg Jorgenson crossed my feed reader yesterday.

He makes a strong argument for not using overly clever or patently silly examples in documentation. Very valid point. Lots of documentation suffers from this. It certainly exists in documentation I've had a hand in writing. Something to work on.

I have a lot I want to write about documentation and the expectations (both the realistic ones and the clearly drug induced) people have of it. Might require regular blogging, though. That would be novel

Topics: software/documentation