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.

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

    {! insider.display.menuOptionsLabel !}

    Everything included in Insider Basic, plus the digital magazine, extensive archive, ad-free web experience, and discounts to partner offerings and MIT Technology Review events.

    See details+

    Print + Digital Magazine (6 bi-monthly issues)

    Unlimited online access including all articles, multimedia, and more

    The Download newsletter with top tech stories delivered daily to your inbox

    Technology Review PDF magazine archive, including articles, images, and covers dating back to 1899

    10% Discount to MIT Technology Review events and MIT Press

    Ad-free website experience

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