A Collection of Articles
Edit
Simson Garfinkel

A View from Simson Garfinkel

Annals of Bad Documentation

Clover Kicker (probably not his real name) has written an amusing article on Kuro5hin.com (“technology and culture, from the trenches”). Although officially a guide for writing “bad documentation,” it’s really a guide about what differentiates good documentation from bad documentation.Probably…

  • October 1, 2003

Clover Kicker (probably not his real name) has written an amusing article on Kuro5hin.com (“technology and culture, from the trenches”). Although officially a guide for writing “bad documentation,” it’s really a guide about what differentiates good documentation from bad documentation.

Probably the most important lessons here is that more documentation isn’t necessarily better documentation, and the more documentation you have, the harder it is to maintain.

Of course, the lessons here are true of any document that needs to be kept up-to-date over time.

Uh oh–you've read all five of your free articles for this month.

Insider basic

$29.95/yr US PRICE

Subscribe
What's Included
  • 1 year (6 issues) of MIT Technology Review magazine in print OR digital format
  • Access to the entire online story archive: 1997-present
  • Special discounts to select partners
  • Discounts to our events

You've read of free articles this month.