Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

I use a similar example when explaining when to document code and when to write it so it is easy to understand. When coding, if you find yourself saying “I need to document this”, you should ask first if it is easily understandable by someone with no knowledge of the code and possibly rewrite it first. Only once you have exhausted how it is written should you document it.

Everyone always nods at this but often do something else in practice, so as an example I use the real-world example of glass doors that only open one way but have identical pull handles on both sides. Users always walk up and loudly and embarrassingly push/pull incorrectly. But instead of fixing the root problem, the people who put them in think, “I know, I will document them!” and put those plaques on each side that says “Push/Pull”. And true to nature, no one reads the signs and still loudly bangs the door the wrong way only then to look at the “documentation”.



Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: