Instructor Notes

The presentation course of this course should be modified depending on the target audience.

Many beginner coders in the research world will not need to know advanced skills such as how to automatically generate and deploy documentation websites, but some introductory material on this topic is here if required. In most cases, only present episodes one to four during the workshop.

Introduction


Writing README files


Documentation strings


Code readability


Contributor guidance


Documentation sites


Command line interfaces