Was man alles mit Klartext-Formaten machen kann

Aufzeigen verschiedenster Klartext-Formate und was man damit machen kann.
Von Yann Vandercoilden (Yann Vandercoilden | LinkedIn) |
Tags:
Categories:

Einführung in die Klartext-Welt

Digitale Inhalte entstehen heute in den unterschiedlichsten Formen: Webseiten, Dokumentationen, Präsentationen oder technische Diagramme. Traditionell werden solche Inhalte häufig mit grafischen Werkzeugen erstellt – etwa mit Word, PowerPoint oder Zeichenprogrammen. Diese Werkzeuge sind intuitiv, haben aber einen entscheidenden Nachteil: Die Inhalte liegen meist in proprietären Dateiformaten vor und lassen sich nur schwer automatisieren, versionieren oder weiterverarbeiten.

Eine Alternative dazu sind Klartext-Formate (Plain Text). Dabei werden Inhalte nicht visuell, sondern über eine einfache, textbasierte Syntax beschrieben. Diese Dateien lassen sich mit jedem Texteditor bearbeiten, einfach versionieren und automatisiert weiterverarbeiten.

Gerade in der Softwareentwicklung, im DevOps-Umfeld und in modernen Dokumentationsprozessen hat sich daher ein Ansatz etabliert, der oft als „Documentation as Code“ bezeichnet wird: Inhalte werden wie Quellcode behandelt – in Klartext geschrieben, in Git versioniert und automatisch veröffentlicht.

Was genau sind Klartext-Formate?

Klartext-Formate sind Dateiformate, deren Inhalt aus normal lesbarem Text besteht. Sie benötigen keine spezielle Software, um gelesen zu werden, sondern können mit jedem einfachen Editor geöffnet werden.

Typische Eigenschaften von Klartext-Formaten sind:

  • Lesbarkeit für Menschen – auch ohne spezielle Software

  • Einfache Struktur durch leichte Markup-Syntax

  • Versionskontrolle mit Systemen wie Git

  • Automatisierbarkeit durch Build-Pipelines

  • Portabilität über verschiedene Systeme hinweg

Ein Beispiel ist eine einfache Markdown-Datei:

# Titel  
  
Dies ist ein Absatz.  
  
- Punkt 1  
- Punkt 2

Der Text bleibt lesbar, auch wenn er noch nicht gerendert wurde.

Diese Eigenschaft unterscheidet Klartextformate grundlegend von Formaten wie .docx, .pptx oder .vsdx, die intern komplexe XML-Strukturen enthalten und nur mit spezieller Software sinnvoll bearbeitet werden können.

Welche Formate gibt es?

Klartextformate lassen sich grob in zwei Kategorien einteilen:

  1. Formate zur Strukturierung von Text

  2. Formate zur Beschreibung von Visualisierungen

Beide folgen dem gleichen Prinzip: Inhalte werden über eine einfache Syntax beschrieben und anschließend automatisch gerendert.

Formate für Textverarbeitung

Markdown

Markdown ist das vermutlich am weitesten verbreitete Klartextformat. Es wurde entwickelt, um Text möglichst einfach zu strukturieren, ohne die Lesbarkeit zu beeinträchtigen.

Typische Einsatzgebiete sind:

  • README-Dateien

  • technische Dokumentationen

  • Webseiten

  • Wissensdatenbanken

Markdown verwendet eine sehr einfache Syntax:

# Überschrift  
  
## Unterüberschrift  
  
**Fett**  
*kursiv*  
  
- Liste  
- Liste

Die Stärke von Markdown liegt in seiner Einfachheit und breiten Unterstützung. Plattformen wie GitHub, GitLab oder viele CMS-Systeme unterstützen Markdown direkt.

Der Nachteil: Die Funktionalität ist bewusst begrenzt. Komplexere Dokumentstrukturen sind damit schwieriger umzusetzen.

AsciiDoc

AsciiDoc ist ein deutlich mächtigeres Textformat als Markdown. Es richtet sich vor allem an technische Dokumentation und umfangreiche Inhalte.

Im Vergleich zu Markdown bietet AsciiDoc unter anderem:

  • komplexe Dokumentstrukturen

  • Inhaltsverzeichnisse

  • Referenzen

  • Tabellen

  • Variablen und Attribute

  • erweiterbare Funktionen

Beispiel:

= Dokumenttitel  
Autor  
:toc:  
  
== Kapitel  
  
Ein Absatz.  
  
=== Unterkapitel  
  
* Liste  
* Liste

AsciiDoc eignet sich besonders für:

  • umfangreiche technische Dokumentation

  • Handbücher

  • Bücher

  • Architektur-Dokumentationen

Gerade in Verbindung mit Tools wie Antora oder Asciidoctor lassen sich daraus sehr professionelle Dokumentationsportale generieren.

Weitere bekannte Formate

Neben Markdown und AsciiDoc existieren noch weitere textbasierte Markup-Sprachen:

reStructuredText (reST)
Wird häufig im Python-Ökosystem verwendet, etwa für Dokumentationen mit Sphinx.

Org Mode
Ein sehr leistungsfähiges Format aus dem Emacs-Umfeld, das Notizen, Aufgabenverwaltung und Dokumentation kombiniert.

LaTeX
Ein wissenschaftlich geprägtes Textsatzsystem, das besonders für mathematische Inhalte und wissenschaftliche Publikationen verwendet wird.

Textile
Ein älteres Markup-Format, das früher in vielen Wikis eingesetzt wurde.

Formate für Visualisierung

Neben Text können auch Diagramme und Visualisierungen in Klartext beschrieben werden.

Dabei wird nicht gezeichnet, sondern die Struktur eines Diagramms textuell beschrieben.

Mermaid

Mermaid ist eine weit verbreitete Sprache zur Erstellung von Diagrammen in Klartext. Sie wird inzwischen von vielen Plattformen direkt unterstützt, darunter GitHub, GitLab und zahlreiche Dokumentationssysteme.

Ein einfaches Beispiel:

graph TD  
A[Start] --> B{Entscheidung}  
B -->|Ja| C[Aktion]  
B -->|Nein| D[Ende]

Das ergibt:

graph TD  
A[Start] --> B{Entscheidung}  
B -->|Ja| C[Aktion]  
B -->|Nein| D[Ende]

Mermaid unterstützt unter anderem:

  • Flowcharts

  • Sequenzdiagramme

  • Gantt-Diagramme

  • State-Diagramme

  • ER-Diagramme

Der große Vorteil von Mermaid ist die einfache Syntax und breite Integration in moderne Dokumentationsplattformen.

PlantUML

PlantUML ist eine leistungsfähige Sprache zur Beschreibung von UML-Diagrammen und vielen weiteren Diagrammtypen.

Beispiel für ein Sequenzdiagramm:

@startuml  
Alice -> Bob: Anfrage  
Bob --> Alice: Antwort  
@enduml

Das ergibt:

PlantUML-Grafik

PlantUML unterstützt:

  • UML-Diagramme

  • Sequenzdiagramme

  • Komponenten-Diagramme

  • Deployment-Diagramme

  • C4-Modelle

  • Architekturdiagramme

PlantUML ist besonders im Architektur- und Softwaredesign-Kontext sehr beliebt.

Weitere bekannte Formate

Neben Mermaid und PlantUML existieren noch weitere textbasierte Visualisierungssprachen:

Graphviz / DOT
Eine der ältesten Diagrammbeschreibungssprachen für Graphen.

D2
Eine moderne Diagrammsprache mit Fokus auf einfache Lesbarkeit.

Structurizr DSL
Eine Sprache speziell zur Beschreibung von Architekturdiagrammen nach dem C4-Modell.

TikZ
Eine sehr leistungsfähige Diagrammsprache aus der LaTeX-Welt.

Möglichkeiten Anwendungen

Klartextformate sind extrem vielseitig und lassen sich in vielen Bereichen einsetzen.

Notizen

Viele moderne Notizsysteme basieren auf Markdown oder ähnlichen Formaten. Beispiele sind Wissenssysteme, persönliche Wikis oder strukturierte Notizen.

Der Vorteil: Notizen bleiben langfristig lesbar und unabhängig von einer bestimmten Software.

Webseiten

Viele moderne Webseiten werden aus Klartextformaten generiert. Statische Site Generatoren verwandeln Markdown- oder AsciiDoc-Dateien automatisch in HTML-Seiten.

Bekannte Tools sind:

  • Hugo

  • Jekyll

  • MkDocs

  • Antora

Dieses Prinzip wird häufig für Dokumentationswebseiten und Blogs verwendet.

Dokumente

Auch klassische Dokumente lassen sich aus Klartext generieren:

  • PDF

  • Word

  • HTML

  • Präsentationen

Tools wie Pandoc ermöglichen die Konvertierung zwischen zahlreichen Formaten.

Dokumentationen

Technische Dokumentationen profitieren besonders stark von Klartextformaten.

Sie ermöglichen:

  • Versionsverwaltung

  • Zusammenarbeit über Git

  • automatische Builds

  • strukturierte Dokumentationsportale

Dieser Ansatz wird häufig als Docs-as-Code bezeichnet.

Bücher / eBooks

Viele Bücher werden heute aus Klartextquellen erzeugt. Der gleiche Inhalt kann dabei in verschiedene Ausgabeformate transformiert werden:

  • PDF

  • EPUB

  • HTML

Gerade im technischen Bereich ist dieser Ansatz sehr verbreitet.

Präsentationen

Auch Präsentationen lassen sich heute vollständig aus Klartextformaten erzeugen. Statt Folien direkt in Programmen wie PowerPoint oder Keynote zu gestalten, wird der Inhalt zunächst in einer textbasierten Beschreibungssprache geschrieben und anschließend automatisch in eine Präsentation umgewandelt.

Ein einfaches Beispiel in Markdown könnte so aussehen:

# Titel der Präsentation  
  
---  
  
## Problemstellung  
  
- Punkt 1  
- Punkt 2  
  
---  
  
## Lösung  
  
Ein strukturierter Ansatz.

Spezialisierte Präsentations-Frameworks interpretieren diese Struktur und generieren daraus fertige Folien.

Typische Werkzeuge sind:

  • Reveal.js – ein sehr verbreitetes HTML-Präsentationsframework, das häufig mit Markdown kombiniert wird

  • Marp – ein Markdown-basiertes Präsentationssystem mit Fokus auf einfache Erstellung und Export nach PDF oder PowerPoint

  • Slidev – ein modernes Präsentationsframework für Entwickler, basierend auf Markdown und Vue.js

  • Pandoc – kann Markdown oder AsciiDoc in Präsentationsformate wie Reveal.js oder Beamer konvertieren

Ein Vorteil dieses Ansatzes liegt darin, dass Präsentationen genauso behandelt werden können wie Quellcode oder Dokumentation:

  • Inhalte sind versionierbar

  • Änderungen lassen sich nachvollziehen

  • Präsentationen können automatisch generiert werden

  • Inhalte lassen sich leicht wiederverwenden

Gerade in technischen Umgebungen wird dieser Ansatz zunehmend verwendet, beispielsweise für:

  • Architekturpräsentationen

  • technische Schulungen

  • Konferenzvorträge

  • Projektvorstellungen

Da die Präsentationen auf Klartext basieren, lassen sie sich außerdem leicht mit anderen Artefakten kombinieren – etwa mit automatisch generierten Diagrammen aus PlantUML oder Mermaid.

Bilder

Auch Bilder und Diagramme können aus Klartext generiert werden, beispielsweise:

  • Architekturdiagramme

  • Prozessdiagramme

  • UML-Diagramme

Der Vorteil: Änderungen können einfach im Text vorgenommen und versioniert werden.

Nützliche Tools

Die Arbeit mit Klartextformaten wird durch eine Vielzahl von Werkzeugen unterstützt.

Texteditoren

Grundsätzlich reicht bereits ein einfacher Editor aus. Besonders komfortabel sind jedoch spezialisierte Editoren mit Syntax-Hervorhebung und Vorschau.

Beliebte Beispiele sind:

  • Visual Studio Code

  • Obsidian

  • Typora

  • Sublime Text

Viele dieser Tools unterstützen Plugins für Markdown, AsciiDoc, Mermaid oder PlantUML.

Konverter

Konverter ermöglichen die Transformation zwischen verschiedenen Dokumentformaten.

Ein besonders mächtiges Werkzeug ist Pandoc, das hunderte Formate miteinander konvertieren kann.

Typische Konvertierungen sind:

  • Markdown → PDF

  • Markdown → Word

  • AsciiDoc → HTML

  • Markdown → Präsentation

Versionsverwaltung

Ein großer Vorteil von Klartextformaten ist ihre Integration mit Versionsverwaltungssystemen.

Mit Tools wie Git lassen sich Änderungen:

  • nachvollziehen

  • vergleichen

  • gemeinsam bearbeiten

  • automatisiert veröffentlichen

Gerade für Dokumentationsteams ist dies ein großer Vorteil gegenüber klassischen Office-Dokumenten.

Fazit

Klartextformate bieten eine flexible und zukunftssichere Grundlage für die Erstellung digitaler Inhalte. Sie ermöglichen es, Texte, Dokumentationen und Diagramme auf einfache Weise zu strukturieren und automatisiert weiterzuverarbeiten.

Durch ihre Lesbarkeit, Offenheit und gute Integrationsfähigkeit passen sie hervorragend in moderne Entwicklungs- und Dokumentationsprozesse.

Wer Inhalte langfristig wartbar, versionierbar und automatisierbar gestalten möchte, findet in Klartextformaten eine leistungsfähige Alternative zu klassischen Office-Werkzeugen.