Talk (non-conference) (Outreach)

FZJ-2022-04102

http://join2-wiki.gsi.de/foswiki/pub/Main/Artwork/join2_logo100x88.png Docs as code: How to write documentation with developers

Mitchell, J. (Corresponding author)FZJ*

2022

This record in other databases:

Please use a persistent id in citations: doi:10.5281/ZENODO.7260346

Abstract: Documentation is often an overlooked part of software development. Here I discuss the concept of docs-as-code as way to streamline documentation development alongside the code. From writing, reviewing, and testing documentation, I will show how the same workflows used in code development can be applied to documentation. We will look into this concept and show how this can work in practical setting using NEST simulator as an example.

Keyword(s): Documentation ; version control

---

Contributing Institute(s):

1. Computational and Systems Neuroscience (INM-6)
2. Theoretical Neuroscience (IAS-6)
3. Jara-Institut Brain structure-function relationships (INM-10)

Research Program(s):

1. 5235 - Digitization of Neuroscience and User-Community Building (POF4-523) (POF4-523)
2. HBP SGA3 - Human Brain Project Specific Grant Agreement 3 (945539) (945539)
3. Helmholtz Platform for Research Software Engineering - Preparatory Study (HiRSE_PS-20220812) (HiRSE_PS-20220812)

Appears in the scientific report 2022

---