Episode 4: Documentation for Research Code


23 January 2025 @ 8:30 - 10:00 am UTC (your local time)


Do you dread writing documentation for the code you develop as part of your research projects?

This month we will focus on the motivation for creating documentation for research code, different types of documentation, some small additions that can already make a world of difference to the usability of your code (for yourself and others!) for example, in-code comments and README files. We’ll also look at some more advanced documentation options.

Our Speakers

Watch this page for updates on our speaker panels!

Jenny Wong (she/her)

2i2c (US-based organisation)





Technical Content Developer


Jenny is a Technical Content Developer at 2i2c, a US-based non-profit that provides a global network of interactive computing platforms for research and education communities. She primarily supports folks with getting the most out of cloud-native workflows through documentation, training and community engagement. She is passionate about democratising access to large-scale, scientific cyber-infrastructure and loves using her deep technical knowledge and friendly communication skills to bridge together technology and people.

Joel Nitta

Chiba University, Japan





Associate Professor


I am an evolutionary biologist with a focus on fern ecology and evolution at Chiba University, Japan. I use, create, and teach tools to enable open, reproducible science. My programming language of choice is R. I obtained my BA from UC Berkeley, MS from the University of Tokyo, and PhD from Harvard University. I am a certified instructor for The Carpentries and am active in communities of practice including ROpenSci, The Carpentries, and RSE Asia.

Mthetho Vuyo Sovara

Centre for High Performance Computing (CHPC), National Integrated Cyberinfrastructure System (NICIS), South Africa


Research Support Scientist


I am passionate about understanding ocean-atmosphere interactions in southern Africa. My research leverages advanced research software, computational models, and data science techniques powered by high-performance computing (HPC) to improve weather and climate forecasts, supporting climate policy and tackling environmental challenges. Additionally, I work to empower postgraduate students across southern Africa through training in coding, research software, and HPC optimization. My initiatives span from high school outreach programs to advanced university workshops, fostering technical expertise and innovation in climate and computational research. These efforts aim to build capacity and advance scientific understanding in the region.