notes to software documentation writers

Sep 04, 2008 15:07

DON'T write documentation that says the web application I've just installed can be found on port 8080 if the config file defaults to broadcasting it on port 8888

DON'T use a font that blends the minus sign preceding a system variable value with the lower bar of the equals sign between the variable name and the variable value

it's stupid shit like that that increases the number of grey hairs in my beard each day...
Previous post Next post
Up