About this event#
Do you dread writing documentation for the code you develop as part of your research projects?
This episode focused on the motivation for creating documentation for research code, different types of documentation, and some small additions that can already make a world of difference to the usability of your code — for yourself and others. We covered in-code comments and README files through to more advanced documentation options.
Useful resource: CodeRefinery lesson on Documenting Research Code
Speakers#
| Name | Role | Organisation |
|---|---|---|
| Jenny Wong | Product Manager | 2i2c |
| Joel Nitta | Associate Professor | Chiba University, Japan |
| Mthetho Vuyo Sovara | Research Support Scientist | Centre for High Performance Computing (CHPC), NICIS, South Africa |