Good Practices for Research Software Documentation
 

The IDEAS Productivity project, in partnership with the DOE Computing Facilities of the ALCF, OLCF, and NERSC and the DOE Exascale Computing Project (ECP) has resumed the webinar series on Best Practices for HPC Software Developers, which we began in 2016.

As part of this series, we offer one-hour webinars on topics in scientific software development and high-performance computing, approximately once a month. The February webinar is titled Good Practices for Research Software Documentation, and will be presented by Stephan Druskat (Friedrich Schiller University Jena) and Sorrel Harriet (Leeds Trinity University). The webinar will take place on Wednesday, February 10, 2021 at 1:00 pm ET.

Abstract

This webinar aims to introduce the importance of software documentation and the different approaches that may be taken at various stages, and on various levels, in the software development life cycle. Through the sharing of examples and stimulative questions, the speakers aim to encourage the audience to reflect on the relationship between documentation and process, and to make informed choices about when and how to document their software.