Dokumentation, die Ihren Code überlebt

adoc Studio bringt Ihre Dokumentation neben den Code, mit echten Includes aus der Codebase, Git-nativen Reviews und Single-Source-Export nach HTML, PDF und statischen Sites.

Docs as Code

Dokumentation lebt neben dem Code

Wenn Ihre Doku in einem separaten Tool wohnt, veraltet sie. adoc Studio nutzt Klartextdateien im selben Repository wie Ihren Swift- oder Objective-C-Code. Pull Requests umfassen Code und Doku in einem Schritt. Reviews laufen im gewohnten Workflow.

Doku im Code-Repository
Pull Requests für Code und Doku
Keine separate Plattform zu pflegen

Code-Beispiele

Schluss mit veralteten Snippets

Code-Beispiele in der API-Doku driften ab, sobald sich das echte API ändert. adoc Studio bindet ganze Dateien oder markierte Abschnitte direkt aus der Codebase ein. Was im Beispiel steht, lässt sich kompilieren. Callouts und Annotationen erklären die kritischen Stellen.

Includes aus echten Quelldateien
Über 100 Sprachen mit Syntax-Highlighting
Callout-Annotationen für komplexe Stellen

Single Source

Ein Quelltext, jede Ausgabe

API-Referenz, README, internes Onboarding und gehostete Doku-Site stammen aus derselben Quelle. adoc Studio exportiert nach HTML, PDF und statischen Sites in einem Build. Eine Änderung erreicht alle Kanäle gleichzeitig, ohne Copy-Paste zwischen Tools.