| site | sandpaper::sandpaper_site |
|---|
Have you ever been handed a piece of legacy code to use or maintain, only to find that there is little to no documentation? How long have you spent trying to decompose and understand its functionality?
In this lesson, students will learn about the different types of software documentation, as well as how to write it well and tools to enable better documentation habits.
:::::::::::::::::::::::::::::::::::::::::: prereq
- Basic understanding of git
- git (installed locally)
- Basic understanding of python
- Python 3.10+ with pip (installed locally)
- Text editor
- GitHub account
- Copy of INTERSECT Practice Template
::::::::::::::::::::::::::::::::::::::::::::::::::