Expert Python Programming - Third Edition

Use a light but sufficient approach

In most agile methodologies, documentation is not the first citizen. Making software that just works is more important than the detailed documentation. So, a good practice, as Scott Ambler explains in his book Agile Modeling: Effective Practices for eXtreme Programming and the Unified Process, John Wiley & Sons, is to define the real documentation needs, rather than try to document everything possible.

For instance, let's look at some example documentation of a simple project that is available on GitHub. ianitor (available at https://github.com/ClearcodeHQ/ianitor) is a tool that helps to register processes in the Consul service discovery cluster, and it is mostly aimed at system administrators. If you ...