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

Written By
CS
Carla Schroder
Dec 5, 2008

“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

CS

Carla Schroder

Linux Today Logo

LinuxToday is a trusted, contributor-driven news resource supporting all types of Linux users. Our thriving international community engages with us through social media and frequent content contributions aimed at solving problems ranging from personal computing to enterprise-level IT operations. LinuxToday serves as a home for a community that struggles to find comparable information elsewhere on the web.

Property of TechnologyAdvice. © 2026 TechnologyAdvice. All Rights Reserved

Advertiser Disclosure: Some of the products that appear on this site are from companies from which TechnologyAdvice receives compensation. This compensation may impact how and where products appear on this site including, for example, the order in which they appear. TechnologyAdvice does not include all companies or all types of products available in the marketplace.