Simple rules to follow when you write technical docs.
-
Explain stupid things. Do not overestimate reader's understanding. Make you instructions and explanations so straightforward and verbose so your mom could follow them;
-
Do not put periods at the end of headers. "Introduction", not "Introduction.";
-
Let abbreviations to be abbreviations. They should be all