
Bad documentation says what things are. Good documentation says what they do.
A few years ago a user on Stack Exchange asked why the construction used in this English sentence is not considered a double negative.
If I don’t use the microphone, nobody will hear me.
Those of use who work in IT are frequently called upon to explain our work to people who are less familiar with computers than we are. It should be our goal to speak and write as clearly as possible. To do that we must avoid jargon, slang and expressions which are easily misunderstood. We should not write to be understood. We should write so as not to be misunderstood.
Continue reading Communicating Clearly About Computing