How to lower the entry barrier to your scientific software


Thorough documentation is essential to ensure correctness, usability, and adoption of open-source software for science. In this presentation, I will discuss a practical framework to setup the documentation of a scientific software project that caters to the needs of all its users, from graduate students to software engineers. This strategy declines the "Diátaxis" approach developed by Daniele Procida to the world of scientific software. The key players in this approach are tutorials, how-to guides, explanations, reference, and comments. I will also provide practical tips to make the overall project more accessible.

Ballroom F
Friday, March 15, 2024 - 17:00 to 18:00