Zurück zum Blog

Technische Dokumentation offline auf dem iPad lesen

Die meisten Dokumentationswerkzeuge exportieren statisches HTML. MkDocs, Sphinx, Docusaurus, Hugo, eine generierte API-Referenz: Das Ergebnis ist ein eigenständiger Ordner, gebaut für den Betrieb ohne Verbindung. Genau das brauchen Sie im Flugzeug, im Keller eines Rechenzentrums oder bei einem Kunden, dessen WLAN Ihren Laptop abweist.

Bleibt, ihn auf dem mitgebrachten Tablet zu öffnen.

Warum PDF nicht die Antwort ist

Der Reflex ist, die Dokumentation als PDF zu exportieren. Das funktioniert, und für ein kurzes Dokument ist es oft die richtige Wahl. Technische Dokumentation verliert bei der Umwandlung aber viel.

Dabei existiert der HTML-Export längst, und er enthält all das.

Die Dokumentation so behalten, wie sie erzeugt wurde

Pagira öffnet den Exportordner, wie es ein Browser täte: die Seitenleiste, die Links zwischen Seiten, die Codehervorhebung. Sie konsultieren die Dokumentation, nicht eine Fotografie davon.

  1. Kopieren Sie den Exportordner nach Dateien oder in iCloud Drive.
  2. Öffnen Sie ihn mit Pagira.
  3. Navigieren Sie wie auf der Website: Die Symbolleiste bietet zurück, vorwärts und neu laden.

iCloud Drive und die Offline-Frage

Erzeugte Dokumentation umfasst oft mehrere Hundert Megabyte, Bilder und Schriften eingerechnet. In iCloud Drive abgelegt, lädt sie beim Lesen nach, ohne Wartezeit vor der ersten Seite.

Laden Sie vor einer Reise eine dauerhafte Offline-Kopie. Der Download ist fortsetzbar, ein Verbindungsabbruch beginnt also nicht von vorn, und ein Hinweis macht klar, was ohne Netz verfügbar bleibt. Siehe aus iCloud Drive streamen oder offline sichern.

Die Seiten vorbereiten, die Sie brauchen werden

Es gibt erlittenes Offline und vorbereitetes Offline. Wissen Sie schon, welche Abschnitte Sie konsultieren werden, sichern Sie sie vor der Abreise in der Leseliste. Jedes Objekt wird als vollständiger Schnappschuss statt als Lesezeichen abgelegt und bleibt lesbar, auch wenn der Quellordner sich bewegt. Siehe die Leseliste.

Der Fall gemischter Dokumentation

Unternehmensdokumentation mischt fast immer HTML-Seiten und PDFs: eine Spezifikation, ein Architekturdiagramm, einen Vertragsanhang. Beides öffnet in derselben App, und ein Link von einer Seite auf ein PDF öffnet an Ort und Stelle.

FAQ

Und eine Dokumentation von mehreren Gigabyte?

Das Streaming aus iCloud erspart es, alles auf einmal zu laden. Für vollständigen Offline-Zugriff ist der freie Speicher auf dem Gerät die Grenze.

Meine Dokumentation ist vertraulich

Es wird nichts verschickt. Alles wird lokal dargestellt, und genau das ist das Argument gegen einen Online-Dokumentenbetrachter.

Kann ich sie auch auf dem iPhone lesen?

Ja, eine App deckt beide ab, und zuletzt geöffnete Objekte lassen ein auf dem anderen Gerät begonnenes Dokument fortsetzen.

Wie öffne ich sie aus einem anderen Werkzeug?

Über das Teilen-Menü, mit Mit Pagira öffnen, aus Dateien oder aus jeder App. Siehe von überall öffnen.