Reference

Reference guides are technical descriptions of the machinery and how to operate it. Reference material is information-oriented. (https://diataxis.fr/how-to-guides/)

Was gehört hierher? Insbesondere natürlich die üblichen Verzeichnisse

  • Glossar, Abkürzungsverzeichnis
  • ggf. Stichwortverzeichnis
  • Literaturverzeichnis

aber auch:

  • weitgehende Dokumentation von Chats mit der KI
  • KI-erzeugte Texte, die man an anderer Stelle gekennzeichnet einbaut

Problem: Markdown-Dateien können wir hier direkt einfügen, auch ipynb. Aber wie halten wir es mit Dateien, für die es keine äquivalente Markdown-Datei gibt (text: pdf; Daten: xls, csv; Code: Python-Bibliotheken, makefiles)? Lösung: Für nicht-Markdown Dateien legen wir Stellvertreter-Dateien mit einer Beschreibung (“Aboutness”) und Download-Links an.