This video presentation from the 2016 Argonne Training Program on Extreme-Scale Computing explains why documentation is important in software development, and how to effectively create and maintain code documentation.
| Resource information | Details |
|---|---|
| Tutorial Title | Documenting Your Code |
| Presenter | Alicia Klinvex |
| Web Links | Video |
This short video presentation from the 2016 Argonne Training Program on Extreme-Scale Computing (ATPESC) gives an overview of why documentation is important in scientific computing projects, different kinds of documentation and strategies for writing effective documentation. It also includes a brief Doxygen tutorial, which will be of interest to readers who are keen on learning about how to use automated documentation tools for their projects.
