Documentation

5.4.1. Documentation#

Comprehensive documentation of the entire project, including the rationale behind decisions, methodologies used, and any challenges encountered, to facilitate understanding and reproducibility.

How?

  • Use the README.md file as central location for your documentation of the content.

  • Make use of Issues and Merge/Pull Requests to declare what you are doing (Issue) and how you are doing it (Merge/Pull Request).