This title appears in the Scientific Report :
2022
Please use the identifier:
http://dx.doi.org/10.5281/ZENODO.7260346 in citations.
Docs as code: How to write documentation with developers
Docs as code: How to write documentation with developers
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 appl...
Saved in:
Personal Name(s): | Mitchell, Jessica (Corresponding author) |
---|---|
Contributing Institute: |
Jara-Institut Brain structure-function relationships; INM-10 Computational and Systems Neuroscience; IAS-6 Computational and Systems Neuroscience; INM-6 |
Imprint: |
2022
|
DOI: |
10.5281/ZENODO.7260346 |
Conference: | HiRSE Seminar Series (virtual), |
Document Type: |
Talk (non-conference) |
Research Program: |
Helmholtz Platform for Research Software Engineering - Preparatory Study Human Brain Project Specific Grant Agreement 3 Digitization of Neuroscience and User-Community Building |
Subject (ZB): | |
Publikationsportal JuSER |
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. |