Presentation Open Access
Good Practices for Research Software Documentation
Stephan Druskat;
Sorrel Harriet
This presentation aims to introduce the importance of software documentation and the different approaches that may be taken at various stages, and on various levels, in the software development life cycle. Through the sharing of examples and stimulative questions, the speakers aim to encourage the audience to reflect on the relationship between documentation and process, and to make informed choices about when and how to document their software.
The IDEAS Productivity project, in partnership with the DOE Computing Facilities of the ALCF, OLCF, and NERSC and the DOE Exascale Computing Project (ECP) has resumed the webinar series on Best Practices for HPC Software Developers, which they began in 2016. The presentation is part of this webinar series.
| Name | Size | |
|---|---|---|
|
good-practices-for-research-software-documentation.pdf
md5:24d67917953d1b1abf17d4e61f6db838 |
42.4 MB | Download |
| All versions | This version | |
|---|---|---|
| Views | 44 | 44 |
| Downloads | 37 | 37 |
| Data volume | 1.6 GB | 1.6 GB |
| Unique views | 40 | 40 |
| Unique downloads | 33 | 33 |
- Publication date:
- February 10, 2021
- DOI:
-
- Keyword(s):
- research software software documentation good practices
- Related identifiers:
- Documented by
- Source of
- License (for files):
- Creative Commons Attribution 4.0 International