Documentation

This page will describe Eco-Libre's approach to documentation, which platforms we use for what, and why.

Why?

Documentation is critical. It's a core component of Eco-Libre's mission statement.

We don't approach documentation as an afterthought. As an Eco-Libre volunteer, you should expect to spend ~50% of your time writing documentation describing your work.

Another common mistake is to hold-off on documentation indefinitely "because it's not ready" -- that's not what we do at Eco-Libre. We document everything.

• We document our daily work in our work logs (including successes, failures, and premature "just thinking aloud")
• We document checkpoints whenever we overcome a hurdle, or to keep the community up-to-date on our progress
• We document polished releases, clearly describing how to build our tech