What is it about?
Our results show that research software documentation doesn't show the big picture. Recommendations don't consider the important role of researchers, who write research software. We also demonstrate that research software always has a history that affects the documentation.
Photo by Patrick Tomasso on Unsplash
Why is it important?
We found that researchers often don’t know why they’re documenting. The documentation for research software is missing a large picture. This paper defines a new approach for what purpose and what appearance documentation is intended and who has to document what for whom depending on the domain. The paper shows that the purpose of documenting research software is unclear. Until now, the focus has been on research software engineers and users. Here, the researcher who develops features to an existing research software is brought into focus. Open source research has been considered, but a lot of research doesn't take place publicly. Documentation is needed to make sure that research can last.
Read the Original
This page is a summary of: Documenting research software in engineering science, Scientific Reports, April 2022, Springer Science + Business Media, DOI: 10.1038/s41598-022-10376-9.
You can read the full text:
Case Study Database for: Documenting Research Software in Engineering Science
This dataset contains the collected data of a case study on the documentation of research software in the institutional everyday life of engineering scientists. All files beginning with "Notes" contain personal thoughts and transcripts. More detailed descriptions about the content of the files are located directly on the file.
The following have contributed to this page