Tips For Documentation Writers (This Means You Too, Ace Coders)

“It might be worth mentioning that decent documentation benefits
everyone; I mention it because it seems that not everyone
understands this. It benefits software developers because then
users won’t pester them as much. (Don’t complain about getting
asked the same question over and over– publish a FAQ.)
Knowledgeable users help other users and figure out cool ingenious
hacks. Users turn into contributors more easily when they don’t
have to dive into source code to figure out anything. Having to
figure out everything the hard way is a waste of time.

“This all might sound odd coming from someone who makes a living
writing Linux howtos, but way too much of it is painfully figuring
out the basics. I’d rather be getting into fun advanced and
creative things than having to continually start from the
beginning.”

Complete
Story