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

Document all the things! (How again?)

Druskat, Stephan (2019) Document all the things! (How again?). Collaborations Workshop 2019, 01.-03. Apr. 2019, Loughborough, UK. DOI: 10.6084/m9.figshare.5432788

[img] PDF
455kB

Abstract

Documentation is key in sustaining (research) software. How can we expect future users, developers and maintainers to run, use, contribute to or maintain software if they cannot refer to its documentation? While this point seems - almost tautologically - clear, the question of how to best document a software project remains unanswered, although there are ongoing efforts, including dedicated conferences such as "Write The Docs", that aim to provide answers. In this mini-workshop we will have a brief look at a specific aspect of documentation: documentation types. Based on a use case from a new research project working to sustain a research software, we will discuss requirements of documentation for research software in terms of: (1) What must or should be documented? What types of documentation should a research software project provide in order to survive and be re-usable? Is there a minimal set and a maximal set of required documentation types or levels? (2) How do the different types of required documentation determine how the documentation should actually be written (or generated)? (3) What are the requirements for tooling that supports the creation of the required documentation? Is such tooling available? In the course of the workshop we will try to find some answers to these questions, with the aim to generate the starting point for a document on the documentation of research software. We can then collaborate further on this document during the hack session to create an output (a blog post/whitepaper/publication) that will help other research software practitioners to configure documentation of their own projects respectively.

Item URL in elib:https://elib.dlr.de/131334/
Document Type:Conference or Workshop Item (Speech, Other)
Title:Document all the things! (How again?)
Authors:
AuthorsInstitution or Email of AuthorsAuthors ORCID iD
Druskat, StephanStephan.Druskat (at) dlr.dehttps://orcid.org/0000-0003-4925-7248
Date:2 April 2019
Refereed publication:No
Open Access:Yes
Gold Open Access:No
In SCOPUS:No
In ISI Web of Science:No
DOI :10.6084/m9.figshare.5432788
Status:Published
Keywords:research software, documentation, best practices, software sustainability
Event Title:Collaborations Workshop 2019
Event Location:Loughborough, UK
Event Type:Workshop
Event Dates:01.-03. Apr. 2019
Organizer:Software Sustainability Institute
HGF - Research field:Aeronautics, Space and Transport
HGF - Program:Space
HGF - Program Themes:Space Technology
DLR - Research area:Raumfahrt
DLR - Program:R SY - Technik für Raumfahrtsysteme
DLR - Research theme (Project):R - Vorhaben SISTEC
Location: Berlin-Adlershof
Institutes and Institutions:Institut of Simulation and Software Technology
Institut of Simulation and Software Technology > Distributed Systems and Component Software
Deposited By: Druskat, Stephan
Deposited On:05 Dec 2019 09:18
Last Modified:05 Dec 2019 09:18

Repository Staff Only: item control page

Browse
Search
Help & Contact
Information
electronic library is running on EPrints 3.3.12
Copyright © 2008-2017 German Aerospace Center (DLR). All rights reserved.