esciencecenter-digital-skills / research-software-support

Content for the Research Software Support platform
https://esciencecenter-digital-skills.github.io/research-software-support/
Other
3 stars 4 forks source link

Software Documentation #132

Open JaroCamphuijsen opened 2 months ago

JaroCamphuijsen commented 1 month ago

In the software documentation module, various "types" of documentation are presented in various places. However sometimes these types relate to 1) the purpose or audience of the software (user, developer, deployment), sometimes the type refers to 2) how it is implemented/distributed (README file, website, wiki, comments/docstrings in the code, technical paper or written book could also be added) and sometimes the type means how the documentation is presented/written down (e.g. tutorial, how to, API docs, list of available elements, narration/story). I would like to make a better distinction between these three "types of types" and integrate that in the slides and exercises.