2024-07-31 18:57
Lazy internal documentation is better than no documentation, but incurs a significant cost if a first-time reader can't grasp what's attempting to be communicated. If someone can't rely on the documentation, they'll end up asking for help and ultimately doing a one-off session with a subject matter expert. Be "outrageously clear" and avoid abbreviations and ambiguities unless you're sure your audience will be able to make sense of them.