elib
DLR-Header
DLR-Logo -> http://www.dlr.de
DLR Portal Home | Impressum | Datenschutz | Kontakt | English
Schriftgröße: [-] 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

Kurzfassung

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.

elib-URL des Eintrags:https://elib.dlr.de/131334/
Dokumentart:Konferenzbeitrag (Vortrag, Anderer)
Titel:Document all the things! (How again?)
Autoren:
AutorenInstitution oder E-Mail-AdresseAutoren-ORCID-iDORCID Put Code
Druskat, StephanStephan.Druskat (at) dlr.dehttps://orcid.org/0000-0003-4925-7248NICHT SPEZIFIZIERT
Datum:2 April 2019
Referierte Publikation:Nein
Open Access:Ja
Gold Open Access:Nein
In SCOPUS:Nein
In ISI Web of Science:Nein
DOI:10.6084/m9.figshare.5432788
Status:veröffentlicht
Stichwörter:research software, documentation, best practices, software sustainability
Veranstaltungstitel:Collaborations Workshop 2019
Veranstaltungsort:Loughborough, UK
Veranstaltungsart:Workshop
Veranstaltungsdatum:01.-03. Apr. 2019
Veranstalter :Software Sustainability Institute
HGF - Forschungsbereich:Luftfahrt, Raumfahrt und Verkehr
HGF - Programm:Raumfahrt
HGF - Programmthema:Technik für Raumfahrtsysteme
DLR - Schwerpunkt:Raumfahrt
DLR - Forschungsgebiet:R SY - Technik für Raumfahrtsysteme
DLR - Teilgebiet (Projekt, Vorhaben):R - Vorhaben SISTEC (alt)
Standort: Berlin-Adlershof
Institute & Einrichtungen:Institut für Simulations- und Softwaretechnik
Institut für Simulations- und Softwaretechnik > Verteilte Systeme und Komponentensoftware
Hinterlegt von: Druskat, Stephan
Hinterlegt am:05 Dez 2019 09:18
Letzte Änderung:05 Dez 2019 09:18

Nur für Mitarbeiter des Archivs: Kontrollseite des Eintrags

Blättern
Suchen
Hilfe & Kontakt
Informationen
electronic library verwendet EPrints 3.3.12
Gestaltung Webseite und Datenbank: Copyright © Deutsches Zentrum für Luft- und Raumfahrt (DLR). Alle Rechte vorbehalten.