From 02525d64d1fcf3fdbe9ca1e715c3d2845b721cb2 Mon Sep 17 00:00:00 2001 From: Janik von Rotz Date: Mon, 12 May 2025 09:47:15 +0200 Subject: [PATCH] vault backup: 2025-05-12 09:47:15 --- README.md | 13 ++++++------- Standard für Dokumentationssysteme.md | 15 ++++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 632f1237..4b57fe1b 100644 --- a/README.md +++ b/README.md @@ -16,16 +16,15 @@ Sie ist als Git Repository unter abrufbar. Die Navigation der Wissensdatenbank erfolgt nicht hierarchisch, sondern entlang von Beziehungen. Jeder Wikilink zeigt auf einen Artikel, welcher wiederum andere Artikel verlinkt. -Alle Artikel werden einem der folgenden Bereiche zugeordnet. +Die Wissensdatenbank orientiert sich am [[Standard für Dokumentationssysteme]]. Alle Artikel werden diesen Bereichen zugeordnet: ![[Diátaxis.png]] +Steigen Sie über diese Links in die Wissensdatenbank ein: -Dazu die wichtigsten Begriffe zum Einstieg: - -[[Tutorials]]\ -[[Anleitungen]]\ -[[Referenzen]]\ -[[Erklärungen]] +[[Tutorials]]: Ist eine Lektion.\ +[[Anleitungen]]: Behandelt ein reales Ziel oder Problem.\ +[[Referenzen]]: Enthält technische Fakten.\ +[[Erklärungen]]: Liefert Kontext und Hintergrund. ## Mitarbeit diff --git a/Standard für Dokumentationssysteme.md b/Standard für Dokumentationssysteme.md index cfd0398c..b31e6a4f 100644 --- a/Standard für Dokumentationssysteme.md +++ b/Standard für Dokumentationssysteme.md @@ -5,15 +5,16 @@ type: reference --- # Standard für Dokumentationssysteme -Dieses Wiki orientiert sich am Framework. +[Diátaxis](https://diataxis.fr/) ist ein Framework Dokumentationssysteme. Es unterteilt Dokumentationen in vier Typen. Die vier Typen erfüllen unterschiedliche Anforderungen und haben bestimmten Zweck. ![[Diátaxis.png]] -Alle Artikel im Wiki werden diesen vier Typen zugeordnet: `tutorial`, `howto`, `explain`, `reference` -In eigenen Worten sind die Typen wie folgt zu verstehen: +Wer mehr über Diátaxis erfahren möchte: -* **tutorial**: Die Notiz ist eine Anleitung für ein Tool oder System. -* **explain**: Die Notiz beschreibt ein Begriff oder Konzept. -* **howto**: Die Notiz unterstützt das Troubleshooting oder gibt Anweisungen. -* **reference**: Die Notiz enthält Listen, Flowcharts, Tabellen oder führt nach Extern. \ No newline at end of file +Alle Artikel im Wiki werden diesen vier Typen zugeordnet: + +#tutorial: Ist eine Lektion.\ +#howto: Behandelt ein reales Ziel oder Problem.\ +#referenzen: Enthält technische Fakten.\ +#explain: Liefert Kontext und Hintergrund. \ No newline at end of file