Knowledgebase article template¶
Alle knowledgebase artikelen dienen een eenduidige structuur te hebben zodat studenten makkelijk kunnen navigeren en de informatie kunnen vinden die ze nodig hebben.
Alle artikelen:
- Hebben een titel
- Beginnen met een inleidende tekst waarin wordt vermeld waarom het onderwerp belangrijk is
- Hebben minstens één voorbeeld
- Hebben minstens één oefening
- Verwijzen naar externe bronnen waar studenten meer kunnen leren
- Verwijzen naar aanverwante onderwerpen in de knowledgebase
- Verwijzen naar gebruikte bronnen
Markdown template voor artikelen
---
author: "Naam van de auteur"
title: "Titel van het artikel"
date: "Datum van publicatie"
categories: ["Categorie 1", "Categorie 2"]
---
# Titel
<!-- Inleidende tekst
- Wat is het probleem?
- Waarom is het belangrijk?
- Deel de tekst eventueel in in subkoppen
- Gebruik zo veel mogelijk verschillende technieken om de informatie over te brengen:
- Afbeeldingen
- Videos
- Diagrammen
- Admonitions
- Links
- tabellen
- interactieve voorbeelden
- etc. -->
<!-- Gebruik admonitions voor de voorbeelden en oefeningen zodat deze in het oog springen en makkelijk door studenten te vinden zijn -->
<!-- Ieder kennisbank artikel heeft minstens één voorbeeld -->
!!! example "Voorbeeld"
<!-- Voorbeelden -->
<!-- Ieder kennisbank artikel heeft minstens één oefening.
- De oefening is kort (niet langfer dan 0.5 uur)
- De oefening draagt bij voorkeur niet direct bij aan het project maar is een oefening op zichzelf
- De oefening levert een tastbaar resultaat op dat de student kan gebruiken bij het bewijzen van zijn of haar voortgang -->
!!! note "Oefening"
<!-- Oefening -->
## Bronnen
<!-- Ieder artikel verwijst naar externe bronnen waar studenten meer kunnen leren.-->
### Meer leren
<!-- Bronnen -->
| Bron | Doel |
| -------- | ---- |
| [link]() | |
| [link]() | |
<!-- Verwijs naar zo veel mogelijk aanverwante onderwerpen in de knowledgebase -->
### Gerelateerde onderwerpen
- [link]()
- [link]()
- ...
<!-- Verwijs naar gebruikte bronnen -->
### Bronnen