~?~

~?~

~?~

~?~

index next | previous | Surfing in Kansas » ¶ As a developer, you develop instincts for judging quality of code. One of my favorite interview questions is: When you look at a project’s code for the first time, what are the things you look for? I think this question is telling. Every person has different priorities, and this is a great way to get at them. I have developed quick ways to tell the quality of documentation. This post will be about what they are, and what they mean. Obviously it is just a heuristic, and having these things doesn’t make good documentation. However, the absence of them usually indicates a lack of quality. ¶ If your documentation is a directory full of files on GitHub, I close the tab. With GitHub Pages, Read the Docs, and other places to host generated documentation for free, not making an effort is unforgivable. If this is your project,...