Select your localized edition:

Close ×

More Ways to Connect

Discover one of our 28 local entrepreneurial communities »

Be the first to know as we launch in new countries and markets around the globe.

Interested in bringing MIT Technology Review to your local market?

MIT Technology ReviewMIT Technology Review - logo

 

Unsupported browser: Your browser does not meet modern web standards. See how it scores »

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.

0 comments about this story. Start the discussion »

Reprints and Permissions | Send feedback to the editor

From the Archives

Close

Introducing MIT Technology Review Insider.

Already a Magazine subscriber?

You're automatically an Insider. It's easy to activate or upgrade your account.

Activate Your Account

Become an Insider

It's the new way to subscribe. Get even more of the tech news, research, and discoveries you crave.

Sign Up

Learn More

Find out why MIT Technology Review Insider is for you and explore your options.

Show Me