Documentation Engineering on ProBase

Was man alles mit Klartext-Formaten machen kann

Sat, 14 Mar 2026 00:00:00 +0000

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.

Once-Only in Dokumentationen

Sat, 14 Feb 2026 00:00:00 +0000

Was ist das Once-Only-Prinzip?

Das Once-Only-Prinzip besagt: Daten oder Informationen sollen nur einmal erfasst, gespeichert und gepflegt werden – und an allen relevanten Stellen wiederverwendet werden. Es vermeidet Redundanz, minimiert Fehlerquellen und reduziert Wartungsaufwand. Ursprünglich aus der Verwaltung und dem E-Government bekannt, gewinnt es auch in technischer Dokumentation zunehmend an Bedeutung – besonders in komplexen, agilen und skalierbaren Systemen.

Warum ist Once-Only in Dokumentationen wichtig?

In Softwareprojekten wachsen Dokumentationen oft unkoordiniert:

Mehrere Wege einen Datenfluss zu modellieren

Sat, 17 Jan 2026 00:00:00 +0000

Daten- oder Informationsfluss?

Der Datenfluss beschreibt die Übertragung von rohen, unverarbeiteten Daten, unabhängig ihrer fachlichen Bedeutung.

Beim Informationsfluss geht es hingegen um die Übertragung von verarbeiten bzw. interpretierten Daten, die für den Empfänger einen klaren und erkennbaren Nutzen haben.

Natürlich ist es IT-Umfeld so, dass wenn Informationen transferiert werden müssen, dies auf Basis eines Datentransfers geschieht. Der Datenfluss bildet die technische Grundlage für den Informationsfluss.

Die in diesem Artikel beschriebenen Darstellungsformen verwenden Elemente von beiden Varianten, jedoch steht der Sinn und Zweck des Informationsflusses im Vordergrund.