1. Einleitung

Starten Sie direkt mit der Arbeit in adoc Studio. Dieses Dokument erläutert die Struktur der Anwendung, stellt die wichtigsten Befehle vor und gibt Tipps für die effektive Dokumentation mit der App.

Ein praktisches Beispiel zur Projekteinrichtung liefert Ihnen der Quellcode dieses Dokuments. Das vollständige Benutzerhandbuch öffnen Sie direkt über das Menü: Hilfe  Benutzerhandbuch.

Hinweise in diesem Dokument

Lesen Sie diese Notiz, um zusätzliche Informationen oder Hintergründe zu erhalten.
Beachten Sie diesen Tipp, um besonders nützliche Hinweise oder Vorgehensweisen umzusetzen.
Achten Sie auf diese Warnung, um wichtige Besonderheiten oder potenzielle Risiken nicht zu übersehen.
Folgen Sie diesen Hinweisen, um Probleme zu vermeiden und besonders sorgfältig vorzugehen.
Stop! Handeln Sie nach diesem Hinweis, um Gefahren, Schäden oder negative Konsequenzen zu vermeiden.

  • Externe Links erkennen Sie am Pfeil .

  • Interne Links im Dokument erscheinen als unterstrichene Hyperlinks.

  • Tasten und Schaltflächen sehen so aus: Ja

  • Menübefehle werden so angezeigt: Ablage  Export  Produkte.

  • Tastaturkurzbefehle werden so dargestellt: ^+⌘+E.

  • So erkennen Sie ein Bedienungselement in der App und die dazugehörigen Eingaben.

1.1. Willkommen zu adoc Studio

adocstudio

Mit adoc Studio erstellen Sie technische Dokumentationen effizient und strukturiert. Die App unterstützt Sie bei der Erstellung umfangreicher und klar gegliederter Dokumente.

Nach dem Start befindet sich die Einfügemarke im Editor. Jede Eingabe wird unmittelbar in der rechts angezeigten Vorschau dargestellt.

Diese direkte Rückmeldung ermöglicht eine effiziente und fokussierte Arbeitsweise. Plattformübergreifend steht Ihnen auf Mac, iPad und iPhone eine konsistente und benutzerfreundliche Oberfläche zur Verfügung.

adoc Studio ist eine integrierte Schreibumgebung auf Basis der Auszeichnungssprache AsciiDoc. Sie erstellen damit Dokumente in den Formaten HTML und PDF sowie Webseiten.

Auszeichnungssprache

Viele kennen Microsoft Word oder einen vergleichbaren Texteditor. In den vergangenen Jahren haben sich jedoch Auszeichnungssprachen wie Markdown stark verbreitet. Im Gegensatz zu klassischen Textverarbeitungen zeigen diese Programme das Dokument nicht in einer druckähnlichen Ansicht an, wie es beispielsweise Microsoft Word oder Apple Pages tun. Stattdessen schreiben Sie den Text in einer strukturierten Syntax und wandeln ihn anschließend in ein gewünschtes Ausgabeformat um. Je nach Werkzeug variiert der dafür erforderliche Aufwand.

AsciiDoc

adoc Studio basiert auf AsciiDoc, einer etablierten Auszeichnungssprache. Die Eclipse Foundation standardisiert den Sprachumfang von AsciiDoc (https://asciidoc-wg.eclipse.org) und schafft damit eine zukunftssichere Grundlage. AsciiDoc ermöglicht Einsteigern einen einfachen Zugang und liefert fortgeschrittenen Anwendern einen umfangreichen Funktionsumfang.

Integrierte Schreibumgebung

Eine effiziente und benutzerfreundliche Arbeitsumgebung erfordert eine App, die alle wesentlichen Funktionen integriert. In adoc Studio organisieren Sie Ihre Projekte, verfassen Texte und sehen in der Vorschau das Ergebnis. Die fertigen Dokumente exportieren Sie entweder einzeln oder als Produkte.

adoc Studio bietet umfassende Anpassungsmöglichkeiten. Sie steuern das Erscheinungsbild des Editors und wählen einen passenden Ausgabestil. In adoc Studio stehen Ihnen mehrere Stile zur Verfügung, und neue Stile erscheinen regelmäßig auf der Webseite.

Mit adoc Studio konzentrieren Sie sich vollständig auf die Struktur und den Inhalt Ihrer Dokumente. Sie betonen wichtige Aussagen, heben Textstellen hervor und fügen bei Bedarf Emojis 🙂 ein. Die Trennung von Textquelle und Vorschau lässt Sie Dokumente in unterschiedlichen Stilen, Formaten und mit bedingtem Inhalt erzeugen.

1.2. Neue Funktionen in adoc Studio

Dieses Dokument zeigt vereinzelt Etiketten wie v3 und v4, um Attribute, Funktionen oder Makros einer Version hervorzuheben. Die letzten Versionen sind im Folgenden in umgekehrter Reihenfolge aufgelistet.

adoc Studio 4 vom [hier Datum eintragen]

  • adoc Studio ist jetzt in einer kostenlosen Version und einer Pro-Version verfügbar.

  • Abonnenten der v3 erhalten automatisch die Pro-Version.

Die kostenlose Version enthält alle Funktionen, die zum Erstellen einer HTML-Dokumentation erforderlich sind:

  • Die Programmoberfläche gliedert sich in Projektverwaltung, Editor und Vorschau.

  • Der adoc Coach ist vollständig integriert und erleichtert das Erlernen von AsciiDoc.

  • Die Vorschau zeigt HTML- und PDF-Dokumente.

  • Der Export erfolgt in HTML.

In der kostenpflichtigen Version kommen mit der Aktualisierung diese Funktionen neu hinzu:

adoc Studio 3 vom 23. April 2025

  • Pro Bildauflösungen anpassen und Dateigrößen reduzieren

  • Pro Projektwörterbücher für Ihr Team

  • Pro Kommandozeilenwerkzeug für die Automatisierung

  • Pro Apple-Kurzbefehle für die Automatisierung

  • Drag-&-Drop-Funktionen

  • Projektdateien sortieren

  • Standardstil festlegen

  • Neuer Produktstil: Handbuch

  • SF-Symbole für Icon-Makros

  • Einbindung in bestehende HTML-Seiten

adoc Studio 2 vom 30. Januar 2025

  • AsciiDoc-Callouts

  • Anker auf Inline-Elementen

  • Untertitel für HTML- und PDF-Exporte

  • Unterstützung von AsciiDoc-Bibliographien

  • Icon-Makros inkl. Syntax-Vervollständigung

  • Neuer Produktstil: Leicht

adoc Studio 1 vom 12. Juni 2024

  • Erste öffentliche Version

1.3. Was ist eine Auszeichnungssprache?

Der Begriff Auszeichnung stammt aus der Typografie und bezeichnet das Hervorheben von Textteilen. Dazu gehören:

  • abweichende Schriftvarianten wie kursiv und fett,

  • Kapitälchen,

  • Versalien (GROßBUCHSTABEN),

  • Gesperrt,

  • Unterstrichen oder

  • Eingefärbt sowie

  • verschiedene Schriftgrößen und -arten.

Handschriftliche Markierungen im Manuskript zählten ebenfalls dazu (Wikipedia). Diese Techniken wurden in Software übertragen, wodurch moderne Auszeichnungssprachen entstanden.

Die Sprache Markdown ist ein bekanntes Beispiel für eine Auszeichnungssprache. Sie basiert auf reinem Text, also auf Buchstaben ohne Formatierung. Zusätzliche Markierungen kennzeichnen die Struktur und Bedeutung des Textes, beispielsweise durch Überschriften, Fett- oder Kursivschrift sowie Links.

Eine Auszeichnungssprache verwendet reinen Text, ergänzt durch Markierungen, die Textteile semantisch kennzeichnen. Es existieren zahlreiche Auszeichnungssprachen, die nicht mit Textverarbeitungsprogrammen wie Microsoft Word zu verwechseln sind. Beispiele dafür sind:

  • HTML die Sprache des Internets, weit verbreitet, jedoch oft umständlich in der Handhabung.

  • TeX/LaTeX populäres Satzsystem, selten im Geschäftsleben und schwer zu erlernen.

  • Markdown einfache Auszeichnung, geeignet für kurze und strukturierte Texte; Markierungen definieren Überschriften, Fett- oder Kursivschrift sowie Links.

AsciiDoc wurde aufgrund der Einschränkungen anderer Sprachen aus folgenden Gründen ausgewählt:

AsciiDoc ist eine ausgereifte, leichtgewichtige und semantische Auszeichnungssprache, speziell für technische Dokumentation entwickelt. Sie eignet sich für alle strukturierten Texte. Ein detaillierter Vergleich von Markdown und AsciiDoc liefert zusätzliche Informationen.

Die hohe Verbreitung mit über 10 Millionen Downloads (Asciidoctor History) gewährleistet umfangreiche Unterstützung.

Bei ProjectWizards entstehen seit 2007 alle Handbücher und öffentlichen Dokumente in diesem Format.

1.4. Betrachtung von Word, Pages oder Google Docs

Wenn die Wahl zwischen adoc Studio und einem WYSIWYG-Textverarbeitungsprogramm wie Microsoft Word, Apple Pages oder Google Docs getroffen wird, sind folgende Punkte zu beachten:

WYSIWYG steht seit den 1990er Jahren für "What you see is what you get". Der Begriff bezeichnet das Prinzip, Dokumente genau so auszugeben, wie sie auf dem Bildschirm dargestellt werden. Mit anderen Worten: Was du siehst, ist das, was du bekommst, ein Anspruch, der damals wie heute in Details häufig nicht erfüllt wird.

  1. Trennung von Inhalt und Darstellung: Textbasierte Markup-Sprachen trennen Inhalt und Darstellung konsequent. Dadurch bleibt die Formatierung über verschiedene Dokumente hinweg konsistent. Gleichzeitig lässt sich das Erscheinungsbild zentral und einheitlich anpassen.

  2. Portabilität: Textbasierte Markup-Sprachen sind universell und plattformübergreifend einsetzbar. Texte lassen sich auf jedem Gerät und Betriebssystem bearbeiten, auch ohne spezielle Software für das Zielformat

  3. Versionskontrolle: Markup-Sprachen sind mit Versionskontrollsystemen wie Git kompatibel. Änderungen lassen sich nachvollziehen, vergleichen und gemeinsam bearbeiten.

  4. Wiederverwendbarkeit: Ein in einer Markup-Sprache erstelltes Dokument kann in unterschiedliche Formate konvertiert werden, z. B. HTML für Webseiten, PDF für den Druck oder EPUB für E-Books.

  5. Anpassungsfähigkeit: Textbasierte Markup-Sprachen bieten hohe Flexibilität. Inhalte, Darstellung und Verhalten lassen sich gezielt anpassen. Funktionen, die klassische Textverarbeitungsprogramme häufig nur eingeschränkt unterstützen.

  6. Automatisierung: Skripte und Werkzeuge ermöglichen die automatisierte Generierung und Veröffentlichung von Projekten. Dies spart insbesondere bei umfangreichen Dokumentationen Zeit und reduziert Fehler.

  7. Stabilität und Beständigkeit: Textbasierte Markup-Sprachen gelten als langfristig stabil. Im Gegensatz zu proprietären Dateiformaten ändern sie sich nicht mit jeder Softwareversion.

1.5. Installation

Sie laden adoc Studio aus dem entsprechenden App Store für Ihren Mac oder Ihr iPad bzw. iPhone.

Lesen Sie diesen Text jetzt in adoc Studio, ist die Installation abgeschlossen. Gratulation!

Systemanforderungen

Die Mindestanforderungen für adoc Studio sind:

  • Mac: macOS 14 (Sonoma)

  • iPad: iPadOS 18

  • iPhone: iOS 18

1.6. Versionen, Testphase und Lizenzierung

subscription

Seit Version 4 ist adoc Studio in zwei Varianten verfügbar:

Community-Version

Kostenlos. Sie enthält die grundlegenden Funktionen.

Pro-Version

Erweitert die Community-Version um zusätzliche Funktionen für professionelle und gewerbliche Anforderungen.

Eine Übersicht der Funktionsunterschiede finden Sie hier. Für Unternehmen steht eine zusätzliche Version zur Verfügung:

Enterprise-Version

Sie bietet die gleiche Funktionalität wie die Pro-Version und deckt zusätzlich spezielle Themen zu Abrechnung und Services ab.

Ein Abonnement – unabhängig vom gewählten Modell – ermöglicht den Zugriff auf adoc Studio auf allen persönlichen Geräten (macOS und iOS).

Beim ersten Start von adoc Studio erscheint ein Dialog zur Auswahl des gewünschten Modells. Während der 14-tägigen Testphase stehen alle Pro-Funktionen uneingeschränkt zur Verfügung.

Nach Ablauf der Testphase kann ein monatliches oder jährliches Abonnement abgeschlossen werden. Das Jahresabonnement bietet einen Preisvorteil.

Ohne Abonnement bleibt adoc Studio dauerhaft in der Community-Version nutzbar. Bestehende Projekte bleiben erhalten. Die Pro-Funktionen stehen nicht zur Verfügung.