vault backup: 2025-05-12 09:47:15
This commit is contained in:
2 files changed
+14
-14
No files matched your search
@@ -16,16 +16,15 @@ Sie ist als Git Repository unter <https://github.com/Mint-System/Wiki> 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
|
||||
|
||||
|
||||
@@ -5,15 +5,16 @@ type: reference
|
||||
---
|
||||
# Standard für Dokumentationssysteme
|
||||
|
||||
Dieses Wiki orientiert sich am <https://diataxis.fr/> 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: <https://diataxis.fr/start-here/>
|
||||
|
||||
* **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.
|
||||
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.
|
||||
Reference in new issue
Block a user