RTFM

This is a parody of Stop Writing Code Comments by Brian Norlander, which contains a lot of good advice, but in my opinion, arrives at the wrong conclusion. With respect, I’ve made some minor edits that keep the substance of the advice intact, while completely changing the conclusion.

Start writing documentation.

There is usually a high correlation between bad code and code with no documentation. This is the most obvious sign of messy source code.

The goal of every programmer should be to write code so clean and expressive that the documentation doesn’t need any maintenance. The purpose of every…

Sean Edwards

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store