Glossar

Eine zusätzliche Funktion oder ein zusätzliches Modul, das in Archbee integriert werden kann, um dessen Fähigkeiten zu erweitern, wie beispielsweise das AI Addon für erweiterte AI-Funktionen.

Dokumentieren Sie Ihre API-Endpunkte klar und deutlich und stellen Sie dabei wichtige Details für Entwickler und Benutzer gleichermaßen bereit.

Bausteine für Ihre Dokumentation. Stellen Sie sie sich wie Legosteine für Ihre Inhalte vor. Sie können sie verwenden, um Überschriften, Tabellen, Bilder, Code-Snippets und mehr zu erstellen. Es stehen grundlegende Blöcke, Medien-, Entwickler- und eingebettete Blöcke zur Auswahl.

Interaktive Schaltflächen, die auf andere interne oder externe Seiten verlinken und Benutzer durch Ihre Dokumentation oder Ihre Inhalte außerhalb der Dokumentation führen.

Heben Sie wichtige Hinweise, Tipps oder Warnungen mit visuell unterscheidbaren Callouts hervor, um die Aufmerksamkeit auf Schlüsselinformationen zu lenken.

Halten Sie Ihre Benutzer mit einem Änderungsprotokoll-Block auf dem Laufenden, der Aktualisierungen und Änderungen in Ihrem Projekt dokumentiert.

Ein mehrsprachiger Code-Editor zur Darstellung von Code-Snippets, perfekt für Entwickler.

Organisieren Sie Ihre Code-Snippets in Schubladen und zeigen Sie sie neben Ihren Inhalten an, damit Ihre Dokumentation übersichtlich und benutzerfreundlich bleibt.

Erstellen Sie wiederverwendbare Inhaltsblöcke, die in mehrere Dokumente eingefügt werden können, um Konsistenz sicherzustellen und Zeit zu sparen.

Ihr zentraler Ort zum Erstellen und Bearbeiten von Inhalten. Es ist wie ein digitaler Arbeitsbereich, in dem Sie Shortcuts verwenden, verschiedene Arten von Inhaltsblöcken hinzufügen und Ihren Text mit Markdown oder dem WYSIWYG-Menü formatieren können. Sie können sogar Inhalte aus anderen Tools einbetten und auf andere Dokumente verlinken. Betrachten Sie es als Ihre zentrale Anlaufstelle für alles rund um die Inhaltserstellung!

Integrieren Sie Inhalte aus beliebten Tools wie Loom, Figma und Miro direkt in Ihre Dokumentation für ein konsistentes Erlebnis.

Abschnitte, die erweitert oder reduziert werden können und die Navigation durch komplexe Themen erleichtern.

Laden Sie Dateien hoch und verlinken Sie sie direkt in Ihrer Dokumentation, damit Ressourcen für Benutzer leicht zugänglich sind.

Organisieren und verwalten Sie alle Ihre Dateien an einem zentralen Ort, damit Sie Ressourcen in Ihrer Dokumentation einfach hochladen, darauf zugreifen und sie verlinken können.

Dokumentieren Sie GraphQL APIs effektiv und stellen Sie Benutzern die Informationen bereit, die sie benötigen, um mit Ihren Services zu interagieren.

Werden verwendet, um Titel und Untertitel zur hierarchischen Organisation von Inhalten zu erstellen.

Horizontale Trenner helfen Ihnen dabei, visuelle Unterbrechungen zwischen Abschnitten zu erstellen und den Fluss Ihrer Dokumentation zu verbessern.

Bereichern Sie Ihre Dokumentation mit Bildern und fügen Sie Ihren Inhalten visuellen Kontext und mehr Interaktivität hinzu

Erstellen Sie dynamische Links zu anderen Dokumenten oder externen Ressourcen, um eine einfache Navigation innerhalb Ihrer Inhalte zu ermöglichen.

Verwenden Sie geordnete und ungeordnete Listen, um Informationen in leicht verständliche Punkte aufzuteilen und die Lesbarkeit zu verbessern.

Integrieren Sie Karten, um standortbezogene Informationen anzuzeigen und die Relevanz Ihrer Inhalte zu erhöhen.

Erstellen Sie Flussdiagramme und Diagramme mit der Mermaid-Syntax und fügen Sie Ihrer Dokumentation visuelle Hilfsmittel hinzu.

Organisieren Sie Aufgaben mit Minitaskers in überschaubare Unteraufgaben, inspiriert von Trello, damit Ihre Projekte auf Kurs bleiben.

Erstellen und verwalten Sie wiederverwendbare Inhaltsblöcke, die in mehrere Dokumente eingefügt werden können, um Konsistenz sicherzustellen und Zeit in Ihrer Dokumentation zu sparen.

Container für Dokumente, die nach Teams oder Projekten organisiert sind. Jedes Konto verfügt über einen persönlichen Bereich, und Organisationen können benutzerdefinierte Bereiche mit Zugriffskontrolle erstellen.

Betrachten Sie sie als Ordner für Ihre Spaces. Sie beginnen mit einem namens „Spaces“. Erstellen Sie weitere Ordner, wenn Sie sie benötigen. Sie können Ordner hinzufügen, umbenennen oder löschen (aber nur, wenn sie leer sind). Um einen Space in einen Ordner zu verschieben, ziehen Sie ihn einfach dorthin, verwenden Sie die Verschiebeaktion oder erstellen Sie ihn im Ordner.

Verbinden Sie mehrere veröffentlichte Spaces für eine einfache Navigation zwischen Dokumenten (z. B. Benutzerhandbücher, API-Dokumente). Fügen Sie Links in den Space-Einstellungen hinzu, beschriften Sie sie und veröffentlichen Sie sie. Änderungen an Links werden automatisch über verbundene Spaces hinweg aktualisiert.

Integrieren Sie OpenAPI-Spezifikationen nahtlos, um Ihre API-Dokumentation zu verbessern.

Verwenden Sie den Tabellenblock, um Daten klar und organisiert darzustellen – perfekt für Vergleiche und strukturierte Informationen.

Organisieren Sie Inhalte in mehreren Tabs für eine übersichtliche und effiziente Navigation, sodass Benutzer einfach zwischen Themen wechseln können.

Rendern Sie komplexe mathematische Gleichungen mit TeX, wodurch sich Ihre Dokumentation für technische Themen eignet.

Sind wie Abteilungen für Ihre Benutzer. Sie können verschiedene Gruppen erstellen (wie Ingenieure, Marketing oder Management) und Benutzer diesen zuweisen. Dies hilft Ihnen dabei, Ihre Benutzer zu organisieren und ihnen unterschiedliche Zugriffsebenen für verschiedene Bereiche Ihrer Organisation zu geben.

Präsentieren Sie Inhalte nebeneinander mit dem Vertikal-Aufteilungsblock – ideal für Vergleiche oder zusammengehörige Informationen.

Betten Sie Videos von Youtube und LoomLoom-Plattformen ein, um dynamische Inhalte und Tutorials direkt in Ihrer Dokumentation bereitzustellen.

Visualisieren Sie Prozesse und Workflows mit diesem Block, damit Benutzer Schritte und Abläufe klar verstehen können.

Ein benutzerfreundliches „What You See Is What You Get“-Menü, mit dem Sie Ihre Inhalte visuell formatieren können, wodurch die Dokumenterstellung intuitiv und unkompliziert wird.