Hello,

We noticed you're browsing in private or incognito mode.

To continue reading this article, please exit incognito mode or log in.

Not an Insider? Subscribe now for unlimited access to online articles.

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 of your free articles for this month.

Insider Premium
$179.95/yr US PRICE

Want more award-winning journalism? Subscribe to Insider Plus.
  • Insider Plus {! insider.prices.plus !}*

    {! insider.display.menuOptionsLabel !}

    Everything included in Insider Basic, plus ad-free web experience, select discounts to partner offerings and MIT Technology Review events

    See details+

    What's Included

    Bimonthly magazine delivery and unlimited 24/7 access to MIT Technology Review’s website

    The Download: our daily newsletter of what's important in technology and innovation

    Access to the magazine PDF archive—thousands of articles going back to 1899 at your fingertips

    Special discounts to select partner offerings

    Discount to MIT Technology Review events

    Ad-free web experience

/
You've read all of your free articles this month. This is your last free article this month. You've read of free articles this month. or  for unlimited online access.