This worksheet is designed to help students learn about good documentation practices in software. The worksheet covers this topic at different levels, including documentation of code, variable naming, and project-level READMEs.
The worksheet is in the form of a Jupyter Notebook and includes exercises to help students engage with the concepts and practice applying their learning to real code.
This worksheet was originally designed for the Spring 2020 Software Design course at Olin College of Engineering.
The contents of the notebook are released under the MIT License.