Bad Developer, No Twinkie Part 3: Ignoring documentation

I can’t count the number of times that I’ve seen someone refer to a particular project (whether it be a JavaScript library or a 3D physics engine), only to check it out and find a complete lack of documentation.  I’m not talking about code comments or internal documentation, but end-user documentation.

Don’t ignore documentation if you are producing a product that ‘other’ people are going to have to use.

Yes, maintaining documentation can be a pain in the butt, but it’s part of the job.  If you actually want people to use the thing you are working on, you’ll likely need to instruct them in one form or another – be it a simple README file or a series of video tutorials.  (Although kudos to you if you have created a product that requires minimal effort to understand and use).

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s