Was ist ein Briefdoc?
Ein “Briefdoc” ist mehr als nur eine einfache Notiz - es ist eine auf Effizienz getrimmte Wissens-Kapsel.
Diese Seite erklärt die Philosophie hinter dem Projekt und definiert die standardisierte Struktur, um Informationen schnell erfassbar und urheberrechtlich sauber zu dokumentieren. Dabei orientieren wir uns stark am Diátaxis Framework.
Ein “Briefdoc” ist im Sinne von Diátaxis immer ein How-To Guide oder eine Reference, kein langes Tutorial. Es folgt strikt diesen 5 Bausteinen: Einleitung ➔ Briefing-Box (TL;DR) ➔ Hauptinhalt ➔ Fazit ➔ Fußnoten.
Die Philosophie: Briefdocs vs. Tutorials
Abschnitt betitelt „Die Philosophie: Briefdocs vs. Tutorials“Die Website briefdocs.org kann verschiedene Arten von Dokumentationen beheimaten. Wenn wir aber von einem spezifischen Briefdoc sprechen, meinen wir Folgendes:
- Ein Briefdoc ist zielorientiert (How-To / Reference): Es beantwortet die Frage “Wie löse ich ein ganz bestimmtes Problem?” oder “Wie war nochmal dieser eine Befehl?”. Es ist kurz, prägnant und verzichtet auf lange Hintergrundgeschichten.
- Ein Tutorial ist lernorientiert: Ein Tutorial nimmt den Anfänger an die Hand und lehrt ein Konzept von Grund auf. Tutorials haben auf dieser Website absolut ihre Daseinsberechtigung, sie folgen aber nicht der strikten, komprimierten Briefdoc-Struktur.
Die 5 Bausteine eines Briefdocs
Abschnitt betitelt „Die 5 Bausteine eines Briefdocs“Um eine konsistente Qualität und Lesbarkeit zu gewährleisten, ist jedes Briefdoc (How-To) nach exakt dem gleichen Muster aufgebaut.
1. Die Einleitung
Abschnitt betitelt „1. Die Einleitung“Direkt am Anfang wird in wenigen Sätzen das Problem geschildert, das dieses Dokument löst. Wichtig zur Quellenangabe: Basiert das gesamte Dokument primär auf ein oder zwei bestimmten Videos, Artikeln oder offiziellen Dokumentationen, werden diese Hauptquellen direkt hier fließend im Text als Link erwähnt.
2. Die Briefing-Box (TL;DR)
Abschnitt betitelt „2. Die Briefing-Box (TL;DR)“Das Herzstück des Eintrags. In der markanten Briefing-Box steht die absolute Kern-Erkenntnis. Wenn ein Leser (oder man selbst in 6 Monaten) nur 10 Sekunden Zeit hat, muss hier die Antwort stehen.
3. Der Hauptinhalt
Abschnitt betitelt „3. Der Hauptinhalt“Hier folgt die eigentliche Anleitung oder der Vergleich (z.B. in Form von nummerierten Schritten). Der Text sollte sachlich, präzise und frei von Ablenkungen sein. Spezifische Fakten oder Zahlen belegen wir hier direkt mit Fußnoten.1
4. Fazit & Empfehlung
Abschnitt betitelt „4. Fazit & Empfehlung“Hier wird eine abschließende Bewertung getroffen (z.B. “Für die meisten Fälle ist Methode X die beste Wahl”). Auch weiterführende Artikel oder Dokumentationen, die für ein tieferes Verständnis nützlich sind, werden hier im fließenden Text verlinkt. Es gibt keine separate “Link-Listen”-Überschrift.
5. Die Fußnoten
Abschnitt betitelt „5. Die Fußnoten“Wir nutzen die native Markdown-Fußnoten-Funktion für spezifische Quellenangaben und direkte Zitate. Diese werden am Ende des Dokuments definiert und von unserem System automatisch als saubere Literaturliste ganz unten auf der Seite gerendert.
Fußnoten
Abschnitt betitelt „Fußnoten“-
Das ist ein Beispiel für eine Fußnote. Sie stört den Lesefluss nicht, hilft allerdings dabei, Urhebern die nötige Anerkennung zu geben. ↩