elib
DLR-Header
DLR-Logo -> http://www.dlr.de
DLR Portal Home | Imprint | Privacy Policy | Contact | Deutsch
Fontsize: [-] Text [+]

Good Practices for Research Software Documentation

Druskat, Stephan and Sorrel, Harriet (2021) Good Practices for Research Software Documentation. In: Best Practices for HPC Software Developers. Best Practices for HPC Software Developers, 2021-02-10, online. doi: 10.5281/zenodo.4560770.

[img] PDF
42MB

Official URL: https://doi.org/10.5281/zenodo.4560770

Abstract

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.

Item URL in elib:https://elib.dlr.de/147388/
Document Type:Conference or Workshop Item (Speech)
Title:Good Practices for Research Software Documentation
Authors:
AuthorsInstitution or Email of AuthorsAuthor's ORCID iDORCID Put Code
Druskat, StephanUNSPECIFIEDhttps://orcid.org/0000-0003-4925-7248UNSPECIFIED
Sorrel, HarrietUNSPECIFIEDhttps://orcid.org/0000-0003-0143-6554UNSPECIFIED
Date:10 February 2021
Journal or Publication Title:Best Practices for HPC Software Developers
Refereed publication:No
Open Access:Yes
Gold Open Access:No
In SCOPUS:No
In ISI Web of Science:No
DOI:10.5281/zenodo.4560770
Status:Published
Keywords:software documentation, research software sustainability
Event Title:Best Practices for HPC Software Developers
Event Location:online
Event Type:Other
Event Date:10 February 2021
Organizer:IDEAS Productivity in partnership with the DOE Computing Facilities of the ALCF, OLCF, and NERSC and the DOE Exascale Computing Project (ECP)
HGF - Research field:Aeronautics, Space and Transport
HGF - Program:Space
HGF - Program Themes:Space System Technology
DLR - Research area:Raumfahrt
DLR - Program:R SY - Space System Technology
DLR - Research theme (Project):R - Tasks SISTEC
Location: Berlin-Adlershof
Institutes and Institutions:Institute of Software Technology
Institute of Software Technology > Intelligent and Distributed Systems
Deposited By: Druskat, Stephan
Deposited On:14 Dec 2021 10:40
Last Modified:24 Apr 2024 20:45

Repository Staff Only: item control page

Browse
Search
Help & Contact
Information
OpenAIRE Validator logo electronic library is running on EPrints 3.3.12
Website and database design: Copyright © German Aerospace Center (DLR). All rights reserved.