Glossar
Glossar: In Arbeit 🚧
Unser Glossar befindet sich im Aufbau, aber wir fügen ständig neue Definitionen hinzu. Bleiben Sie dran für mehr!
A
Addon
Ein zusätzliches Feature oder Modul, das in Archbee integriert werden kann, um seine Funktionen zu erweitern, wie zum Beispiel das AI Addon für erweiterte KI-Funktionalitäten.
Dokumentieren Sie Ihre API endpoints klar und präzise und stellen Sie essentielle Details sowohl für Entwickler als auch Nutzer bereit.
B
Blöcke
Bausteine für Ihre Dokumentation. Denken Sie an sie wie an Legosteine für Ihre Inhalte. Sie können sie verwenden, um Überschriften, Tabellen, Bilder, Code-Snippets und mehr zu erstellen. Es gibt grundlegende, Medien-, Entwickler- und eingebettete Blöcke zur Auswahl.
Interaktive Buttons, die zu anderen internen oder externen Seiten verlinken und Nutzer durch Ihre Dokumentation oder externe Inhalte führen.
C
Hinweis
Heben Sie wichtige Hinweise, Tipps oder Warnungen mit klar erkennbaren Callouts hervor, um die Aufmerksamkeit auf zentrale Informationen zu lenken.
Halten Sie Ihre Nutzer mit einem Changelog-Block auf dem Laufenden, der Aktualisierungen und Änderungen in Ihrem Projekt dokumentiert.
Ein mehrsprachiger Code-Editor zur Darstellung von Code-Snippets – ideal für Entwickler.
Organisieren Sie Ihre Code-Snippets in Schubladen und zeigen Sie sie zusammen mit Ihrem Inhalt an, um Ihre Dokumentation übersichtlich und benutzerfreundlich zu halten.
Erstellen Sie wiederverwendbare Inhaltsblöcke, die in mehreren Dokumenten eingefügt werden können, um Konsistenz sicherzustellen und Zeit zu sparen.
D
E
Editor
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 mit anderen Dokumenten 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 einheitliches Erlebnis.
Abschnitte, die erweitert oder reduziert werden können und so die Navigation in komplexen Themen erleichtern.
F
Datei
Laden Sie Dateien hoch und verlinken Sie sie direkt in Ihrer Dokumentation, damit Benutzer leicht auf Ressourcen zugreifen können.
Organisieren und verwalten Sie alle Ihre Dateien an einem zentralen Ort, um Ressourcen einfach hochzuladen, darauf zuzugreifen und sie innerhalb Ihrer Dokumentation zu verlinken.
G
GraphQL
Dokumentieren Sie GraphQL APIs effektiv und stellen Sie Benutzern die Informationen zur Verfügung, die sie für die Interaktion mit Ihren Services benötigen.
H
Wird verwendet, um Titel und Untertitel zur hierarchischen Organisation von Inhalten zu erstellen.
Horizontale Trenner helfen Ihnen, visuelle Unterbrechungen zwischen Abschnitten zu erstellen und verbessern so den Lesefluss Ihrer Dokumentation.
I
Image
Bereichern Sie Ihre Dokumentation mit Bildern und fügen Sie Ihren Inhalten visuellen Kontext und mehr Engagement hinzu
J
K
L
Erstellen Sie dynamische Links zu anderen Dokumenten oder externen Ressourcen, um die Navigation innerhalb Ihrer Inhalte zu erleichtern.
Listen
Verwenden Sie geordnete und ungeordnete Listen, um Informationen in leicht verdauliche Punkte zu gliedern und die Lesbarkeit zu verbessern.
M
Karte
Integrieren Sie Karten, um standortbasierte Informationen anzuzeigen und die Relevanz Ihrer Inhalte zu erhöhen.
Erstellen Sie Ablaufdiagramme und Diagramme mit der Mermaid-Syntax, um Ihrer Dokumentation visuelle Hilfsmittel hinzuzufügen.
Organisieren Sie Aufgaben in handhabbare Unteraufgaben mit Minitaskers, inspiriert von Trello, um Ihre Projekte auf Kurs zu halten.
N
O
P
Q
R
Wiederverwendbare Elemente
Erstellen und verwalten Sie wiederverwendbare Inhaltsblöcke, die in mehrere Dokumente eingefügt werden können, um Konsistenz zu gewährleisten und Zeit in Ihrer Dokumentation zu sparen.
S
Bereiche
Container für Dokumente, organisiert nach Teams oder Projekten. Jedes Konto verfügt über einen persönlichen Space, und Organisationen können eigene mit Zugriffskontrolle erstellen.
Betrachten Sie sie als Ordner für Ihre Spaces. Sie beginnen mit einem Ordner namens "Spaces". Erstellen Sie bei Bedarf weitere Ordner. 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 direkt im Ordner.
Verbinden Sie mehrere veröffentlichte Spaces für eine einfache Navigation zwischen Dokumenten (z. B. Benutzerhandbücher, API-Dokumentation). Fügen Sie Links in den Space-Einstellungen hinzu, benennen Sie sie und veröffentlichen Sie. Änderungen an Links werden automatisch in allen verbundenen Spaces aktualisiert.
Integrieren Sie nahtlos OpenAPI-Spezifikationen, um Ihre API-Dokumentation zu verbessern.
T
Tabelle
Verwenden Sie den Tabellenblock, um Daten klar und übersichtlich darzustellen – perfekt für Vergleiche und strukturierte Informationen.
Tabs
Organisieren Sie Inhalte in mehreren Tabs für eine klare und effiziente Navigation, sodass Benutzer einfach zwischen Themen wechseln können.
Stellen Sie komplexe mathematische Gleichungen mit TeX dar, um Ihre Dokumentation für technische Inhalte geeignet zu machen.
U
Benutzergruppen
Sind wie Abteilungen für Ihre Benutzer. Sie können verschiedene Gruppen (wie Engineers, Marketing oder Management) erstellen und Benutzer diesen zuweisen. Dies hilft Ihnen, Ihre Benutzer zu organisieren und ihnen unterschiedliche Zugriffsebenen auf verschiedene Bereiche Ihrer Organisation zu geben.
V
Stellen Sie Inhalte mit dem Vertical Split Block nebeneinander dar – ideal für Vergleiche oder zusammengehörige Informationen.
Video
W
Workflow
Visualisieren Sie Prozesse und Arbeitsabläufe 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, um die Dokumenterstellung intuitiv und unkompliziert zu gestalten.
X
Y
Z
Hier ist eine markenspezifische Liste zusätzlicher Funktionen, die in Archbee verfügbar sind, jeweils mit Beschreibungen:
Archbee Reusables
- Wiederverwendbare: 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.
Archbee File Manager
- Dateimanager: Organisieren und verwalten Sie alle Ihre Dateien an einem zentralen Ort, sodass Sie Ressourcen in Ihrer Dokumentation einfach hochladen, darauf zugreifen und sie verlinken können.
Archbee Markdown
- Markdown: Nutzen Sie Markdown-Syntax, um Ihren Text schnell und effizient zu formatieren und ein optimiertes Schreiberlebnis zu ermöglichen, während Sie gleichzeitig Flexibilität im Dokumentdesign beibehalten.
Archbee WYSIWYG Menu
- WYSIWYG-Menü: Verwenden Sie einen benutzerfreundlichen "What You See Is What You Get"-Editor, mit dem Sie Ihre Inhalte visuell formatieren können und die Dokumenterstellung intuitiv und unkompliziert wird.
Archbee Emojis
- Emojis: Verbessern Sie Ihre Dokumentation mit Emojis, um Persönlichkeit und visuelles Interesse hinzuzufügen und Ihre Inhalte ansprechender und zugänglicher zu machen.
Archbee Drag & Drop
- Ziehen & Ablegen: Ordnen Sie Blöcke und Inhalte in Ihren Dokumenten mithilfe einer einfachen Drag-and-Drop-Oberfläche neu an, um schnelle Anpassungen und Strukturierungen vorzunehmen.
Archbee Variables
- Variablen: Verwenden Sie Variablen, um dynamische Inhalte einzufügen, die sich je nach Kontext ändern können, wodurch Ihre Dokumentation anpassungsfähig und für verschiedene Benutzer personalisiert wird.
Archbee Space-Specific Variables
- Raumspezifische Variablen: Definieren Sie Variablen, die für bestimmte Spaces einzigartig sind, um Inhalte bereitzustellen, die den Anforderungen verschiedener Projekte oder Teams entsprechen.
Archbee Glossary
- Glossar: Erstellen Sie ein Glossar, um Definitionen und Erklärungen für Fachbegriffe bereitzustellen und das Verständnis und die Zugänglichkeit für Benutzer zu verbessern.
Archbee Docs Tagging
- Dokumenten-Tagging: Organisieren Sie Ihre Dokumente mit Tags für eine einfache Kategorisierung und ein leichteres Wiederauffinden, wodurch Navigation und Suchbarkeit in Ihrer Dokumentation verbessert werden.
Archbee Display Rules
- Anzeigeregeln: Legen Sie Bedingungen fest, wann bestimmte Inhalte angezeigt oder ausgeblendet werden sollen, basierend auf Benutzerrollen oder anderen Kriterien, um ein personalisiertes Benutzererlebnis zu ermöglichen.
Archbee Find & Replace
- Suchen & Ersetzen: Finden und ersetzen Sie schnell Text in Ihrer gesamten Dokumentation, um den Bearbeitungsprozess zu optimieren und Konsistenz sicherzustellen.
Archbee Notifications
- Benachrichtigungen: Bleiben Sie mit Echtzeitbenachrichtigungen über Updates, Kommentare und Änderungen in Ihrer Dokumentation informiert und bleiben Sie mit Ihrem Team verbunden.
Archbee Notification Center
- Benachrichtigungszentrale: Greifen Sie auf ein zentrales Zentrum für all Ihre Benachrichtigungen zu, um Updates effizient zu verwalten und zu überprüfen.
Archbee Comments
- Kommentare: Arbeiten Sie mit Ihrem Team zusammen, indem Sie direkt innerhalb von Dokumenten Kommentare hinzufügen, um Diskussionen und Feedback zu bestimmten Inhalten zu erleichtern.
Archbee Templates
- Vorlagen: Nutzen Sie vorgefertigte Templates, um Ihre Dokumentationsprojekte zu starten und ein konsistentes Erscheinungsbild Ihrer Inhalte sicherzustellen.
Archbee Category
- Kategorie: Organisieren Sie Ihre Dokumente in Kategorien für eine bessere Struktur und einfachere Navigation, damit Benutzer schnell relevante Informationen finden können.
Archbee Dokumentenverlauf
- Dokumentenverlauf: Verfolgen Sie Änderungen und Überarbeitungen, die im Laufe der Zeit an Ihren Dokumenten vorgenommen wurden, sodass Sie bei Bedarf zu früheren Versionen zurückkehren können.
Archbee Überprüfungssystem
- Überprüfungssystem: Implementieren Sie einen strukturierten Überprüfungsprozess für Ihre Dokumente, um Qualität und Genauigkeit vor der Veröffentlichung sicherzustellen.
Archbee Dokumente verifizieren
- Dokumente verifizieren: Stellen Sie die Integrität und Genauigkeit Ihrer Dokumentation sicher, indem Sie Inhalte anhand etablierter Standards oder Richtlinien überprüfen.
Archbee Versteckte Dokumente
- Versteckte Dokumente: Halten Sie bestimmte Dokumente privat oder vor Benutzern verborgen und ermöglichen Sie gleichzeitig deren Indizierung für Suchzwecke, um die Vertraulichkeit zu wahren.
Diese Funktionen ermöglichen es Ihnen, Dokumentation effektiv zu erstellen, zu verwalten und gemeinsam daran zu arbeiten, wodurch das gesamte Benutzererlebnis innerhalb von Archbee verbessert wird.