Refer to Diátaxis framework in DOCBB (#252)

* refer to Diátaxis framework in DOCBB --------- Co-authored-by: Magnus Hagdorn <[email protected]>
the-teachingRSE-project · Apr 12, 2024 · 23c97a2 · 23c97a2
1 parent f442579
commit 23c97a2
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/.github/spellignore.txt b/.github/spellignore.txt
@@ -36,6 +36,7 @@ DaLiJe
 de
 deRSE
 DFG
+Diátaxis
 DigComp
 DigCompEdu
 DigCompOrg

diff --git a/bibliography.bib b/bibliography.bib
@@ -4035,6 +4035,12 @@ @Article{Prlic2012
   publisher = {Public Library of Science ({PLoS})},
 }
 
+@misc{Procida_Diataxis_documentation_framework,
+  author = {Procida, Daniele},
+  title = {{Diátaxis documentation framework}},
+  url = {https://diataxis.fr/}
+}
+
 @Article{Pucker2019,
   author    = {Pucker, Boas and Schilbert, Hanna Marie and Schumacher, Sina Franziska},
   title     = {Integrating Molecular Biology and Bioinformatics Education},

diff --git a/competencies.md b/competencies.md
@@ -470,6 +470,9 @@ what a piece of software aims to do and how to enable others to use the provided
 is primarily achieved through a "clean" implementation and enhanced by
 documentation. Documentation ranges from commenting code blocks to using
 documentation (building) tools.
+It should be written with consideration for the different audiences who may need it 
+depending on their goals and expertise, 
+for example by following the Diátaxis framework @Procida_Diataxis_documentation_framework.
 
 <!-- Building distributable libraries -->
 \skillsection{LIBS}