Tuesday, January 23, 2007

One of the hardest problems software faces today

I think the biggest problem is to get users to read the documentation associated with the software.

Try answering these questions and score yourself.

  1. How many times have you seen a question about a problem being repeated?
  2. Why do you they created FAQs?
  3. How many FAQs have you read?
  4. What was the last release notes you read?
  5. Which book did you read last (not related to your course)?
  6. What new techniques did you read and discover in the last two years?
  7. What kind of documentation did you write and share for your last project?
  8. What was the last software manual you read?
  9. What was the ratio of comments to code in
  • Programs you wrote
  • Programs you read


The answers to these questions might not be a simple yes or no, but it will give you a fair idea of how we programmers are lazy and totally ignore documentation.

2 comments:

Gops said...

I think the hardest problem is to make software so obvious that you don't need manuals/documentation to use it. Well, maybe you'll need it for the more advanced features, but it should be minimal...

But I agree with your general precept that programmers don't read. And that is a shame!

Balbir said...

Gopal, in the UI world, people did try to make the program obvious and added context sensitive help A.K.A Hit the F1 key.

I agree, that the software should be obvious, but how does a command line program become obvious?

My emphasis was on people missing out on reading what is already there and documented and then running programs or using code as if there is a mystical software entity that will help them understand in a jiffy what they need.

Ranking and Unranking permutations

I've been a big fan of Skiena's Algorithm Design Manual , I recently found my first edition of the book (although I own the third ed...