Du hast deinen AdBlocker an?

Es wäre ein Traum, wenn du ihn für t3n.de deaktivierst. Wir zeigen dir gerne, wie das geht. Und natürlich erklären wir dir auch, warum uns das so wichtig ist. Digitales High-five, deine t3n-Redaktion

Entwicklung & Design

DAUX.IO: Per Generator zur eigenen Dokumentation für Software, APIs oder Produkte

DAUX.IO der Dokumentations-Generator (Grafik: Shutterstock)

Software entwickeln, Schnittstellen erstellen oder eigene Produkte verwirklichen – es wird viel Arbeit und Schweiß investiert. Doch was bringt einem die Arbeit, wenn niemand am Ende das Produkt benutzen kann – weil nicht das benötigte Know-how vorhanden ist? Eine Dokumentation muss also her, die übersichtlich und einfach alle wichtigen Funktionen und Möglichkeiten an den Benutzer vermitteln kann. Keine einfache Aufgabe, doch vielleicht haben wir mit DAUX.IO unsere Lösung schon gefunden.

Im schlimmsten Fall ist eine Dokumentation unübersichtlich und schwer nachzuvollziehen. Es wird viel Zeit für die Interpretation benötigt, was Benutzer schnell vom Zug unserer Neuentwicklung abspringen lässt. Um diesem Problem vorzubeugen, sollten wir die Dokumentation nicht in die letzte Schublade unserer gedanklichen Prioritäten verlagern.

Wenn wir die richtige Software benutzen, um unsere Dokumentation zu erstellen, haben wir nicht nur unseren Benutzern einen Gefallen getan, auch wir können von vordefinierten Strukturen, Funktionen und Templates profitieren. Das bringt uns eine große Arbeitsersparnis und weniger Frust.

DAUX.IO: Der Generator für deine Dokumentation

DAUX mit seinem Inline-Editor. (Screenshot: DAUX.IO)
Auf dem Weg zur perfekten Dokumentation: DAUX und der Inline-Editor. (Screenshot: DAUX.IO)

DAUX.IO bezeichnet sich selbst als Generator und ist nicht nur ein Template oder eine Boilerplate, sondern ein vollständiges Toolkit, mit dem wir unsere Dokumentation erstellen können. Zuerst müssen wir DAUX.IO vom offiziellen GitHub-Repository laden und auf unserem Server installieren. Benötigt wird nur eine PHP-5.3+-Unterstützung. Wer DAUX.IO lieber lokal ausführen will, kann das direkt über Grunt tun. Sobald wir jetzt das Verzeichnis auf unserem Server oder lokal aufrufen, erhalten wir ein Abbild der DAUX.IO-Seite.

Im Folgenden können wir die Demo-Dateien anpassen, die wir im Ordner docs finden. Wir können die Markdown-Dateien direkt bearbeiten und speichern. Der Vorteil, dass wir nicht direkt im Quellcode HTML-Elemente verschieben müssen, liegt klar auf der Hand. Auch Unerfahrene können den Inhalt der Dokumentation über die einfache Markdown-Syntax erstellen. Die Ordner unterhalb des docs-Verzeichnisses gliedern automatisch die Navigation und es kann einfach und schnell eine simple Struktur erstellt werden.

Über die dazugehörige config.json-Datei, die sich auch im doc-Verzeichnis befindet, können weitere Einstellungen vorgenommen werden, beispielsweise, was die Google-Analytics-Anbindung, das Template oder den File-Editor angeht, der eine direkte Bearbeitung erlaubt. Zusätzlich gibt es noch die Themes, die sich im Ordner templates > default verstecken. Hier können wir unser eigenes Theme anlegen oder ein vorhandenes bearbeiten.

Die Dokumentation mit DAUX.IO: Die Vorteile im Überblick

Mit DAUX.IO haben wir einen Dokumentations-Generator, der mit wenigen Klicks installiert werden kann. Er besitzt eine eigene Theme-Engine die es erlaubt, das Design anzupassen. Über die Markdown-Syntax können auch Nicht-Entwickler die Dokumentation mit Leben füllen. Die Definition von Menü und Struktur wird einfach und schnell über die Verzeichnishierarchie umgesetzt. Das Routing ist SEO-freundlich und die gesamte Anwendung responsive.

Wenn ihr euch noch unsicher seid, ob DAUX.IO die richtige Lösung ist, könnt ihr euch noch weitere Demos angucken. Wer mit DAUX.IO nichts anfangen kann, ist vielleicht mit der kostenpflichtigen Alternative ReadMe.io besser bedient.

Habt ihr schon Erfahrungen mit DAUX.IO gemacht oder benutzt ihr eine ganz anderer Dokumentations-Software?

Bitte beachte unsere Community-Richtlinien

Schreib den ersten Kommentar!

Melde dich mit deinem t3n Account an oder fülle die unteren Felder aus.