Über die UiPath-Dokumentation

UiPath-Dokumentation, die nach Plattform, Produkt und Bereitstellungsoption organisiert ist, damit Sie den richtigen Inhalt für Ihren Kontext finden.

In diesem Abschnitt wird erläutert, wie die UiPath-Dokumentation strukturiert ist und wie Sie die richtigen Informationen für jedes Angebot, jede Bereitstellungsoption oder jedes Produkt finden.

Der Abschnitt ist in die folgenden Bereiche unterteilt:

1. Plattformen: Wie Sie die Dokumentation für UiPath Plattformen navigieren;
2. Produkte: So finden und nutzen Sie die Dokumentation für einzelne UiPath-Produkte für alle Bereitstellungsoptionen
3. Versionsverwaltung und Verfügbarkeit von Dokumentation: Wie Dokumentation gruppiert und verwaltet wird.

Plattformdokumentation

In der Plattformdokumentation wird erläutert, wie UiPath Platform-Umgebungen installiert, konfiguriert, verwaltet und aktualisiert werden.

Automation Cloud und Test Cloud

Die folgende Tabelle gruppiert die Dokumentation nach Zweck und Scope.

Dokumentationstyp	Dokumentationsleitfaden	Beschreibung
Versionshinweise	Versionshinweise zur Automation Cloud	Fasst Änderungen auf Plattformebene für Automation Cloud, Automation Cloud Public Sector und Automation Cloud Dedicated zusammen, einschließlich Aktualisierungen der Infrastruktur, der Verwaltung und der gemeinsam genutzten Dienste.
	Test-Cloud-Versionshinweise	Fasst Änderungen auf Plattformebene für Test Cloud, Test Cloud Public Sector und Test Cloud Dedicated zusammen, einschließlich Aktualisierungen der Infrastruktur, der Verwaltung und von Shared Services.
Administratorhandbuch	Automation Cloud-Administratorhandbuch	Erläutert, wie Sie Benutzer, Mandanten, Authentifizierung, Lizenzierung und Systemkonfiguration für Automation Cloud, Automation Cloud Public Sector und Automation Cloud Dedicated verwalten können.
	Test Cloud-Administratorhandbuch	Erläutert, wie Sie Benutzer, Mandanten, Authentifizierung, Lizenzierung und Systemkonfiguration für Test Cloud, Test Cloud Public Sector und Test Cloud Dedicated verwalten können.
API-Dokumentation	Automation Cloud-API-Handbuch	Beschreibt die verfügbaren Plattform-APIs für Automation Cloud, Automation Cloud Public Sector und Automation Cloud Dedicated, einschließlich Authentifizierung und Dienstinteraktion.
	Test Cloud-API-Handbuch	Beschreibt die verfügbaren Plattform-APIs für Test Cloud, Test Cloud Public Sector und Test Cloud Dedicated, einschließlich Authentifizierung und Dienstinteraktion

Automation Suite und Test Cloud

Die folgenden Leitfäden enthalten Informationen, die sowohl für Automation Suite als auch für Test Cloud gelten, da die Plattformen dieselbe Bereitstellungsarchitektur und dieselbe Verwaltungserfahrung haben. Die folgende Tabelle gruppiert die Dokumentation nach Zweck und Scope.

Dokumentationstyp	Dokumentationsleitfaden	Beschreibung
Versionshinweise	Versionshinweise zur Automation Suite	Fasst Änderungen auf Plattformebene sowohl für Automation Suite als auch für Test Cloud zusammen, einschließlich Aktualisierungen der Infrastruktur, Verwaltung und Shared Services.
	Test Cloud für Automation Suite Versionshinweise	Fasst Änderungen auf Plattformebene nur für Test Cloud zusammen, insbesondere für Aktualisierungen im Zusammenhang mit Tests.
Installationsdokumentation	Automation Suite in der EKS/AKS-Installationsanleitung	Bietet Anweisungen zur Installation von Automation Suite oder Test Cloud in verwalteten Kubernetes-Diensten: Amazon EKS und Azure AKS.
	Automation Suite in OpenShift – Installationsanleitung	Bietet Anweisungen zur Installation von Automation Suite oder Test Cloud auf Red Hat OpenShift-Clustern.
	Automation Suite unter Linux – Installationsanleitung	Bieten Sie Anweisungen zur Installation von Automation Suite oder Test Cloud in Linux-Umgebungen an, von Bare-Metal-Umgebungen bis hin zu einer virtualisierten Infrastruktur vor Ort.
Administratorhandbuch	Automation Suite-Administratorhandbuch	Erläutert, wie Benutzer, Mandanten, Authentifizierung, Lizenzierung und Systemkonfiguration sowohl für Automation Suite als auch für Test Cloud verwaltet werden.
	Test Cloud – Benutzerhandbuch	Erklärt, wie Sie Test Cloud starten könnenAdministrative Aufgaben und die Plattformkonfiguration sind im Automation Suite-Administratorhandbuch dokumentiert, das für beide Plattformen gilt.
API-Dokumentation	API-Leitfaden	Beschreibt die verfügbaren Plattform-APIs für Automation Suite und Test Cloud, einschließlich Authentifizierung und Dienstinteraktion.

Produktdokumentation

Jedes UiPath-Produkt enthält seine eigene Dokumentation, die in der Regel nach Dokumentationstyp organisiert ist. UiPath ist dabei, die Cloud-Dokumentation in einer einzigen, konsistenten Struktur über alle Cloud-Angebote hinweg zu vereinheitlichen. Weitere Informationen finden Sie im Unified Cloud Documentation Tracker.

Für die Bereitstellungsoptionen Automation Cloud, Automation Cloud Public Sector, Automation Cloud Dedicated und Automation Suite gilt dieselbe Produktdokumentation auch für die entsprechenden Test Cloud-Angebote.Da Automation Cloud und Automation Suite die Infrastruktur und Produktarchitektur mit Test Cloud teilen, ist die Dokumentation einheitlich, es sei denn, eine Funktion ist explizit plattformspezifisch.

Wenn eine Funktion nur auf einer Plattform verfügbar ist, wird der Unterschied auf eine oder beide der folgenden Arten dokumentiert:

• In den Versionshinweisen zum Produkt hervorgehoben.
• Dies ist im entsprechenden Abschnitt des Benutzerhandbuchs zum Produkt angegeben.

Beispielsweise haben Test Manager in Automation Cloud und Test Cloud dieselben Versionshinweise und dasselbe Benutzerhandbuch.Ebenso teilen Test Manager in Automation Suite und Test Cloud für Automation Suite einen einzigen Dokumentationssatz.

Tabelle 1. Dokumentationsstruktur nach Typ und Bereitstellungsoption

Dokumentationstyp	Bereitstellungsoption	Beschreibung	Beispiele
Versionshinweise	Automation Cloud Test Cloud	Ein gemeinsam genutzter Dokumentationssatz für Automation Cloud und Test Cloud. Ein gemeinsam genutzter Dokumentationssatz für Automation Cloud Public Sector und Test Cloud Public Sector. Ein gemeinsam genutzter Dokumentationssatz für Automation Cloud Dedicated.	Die Versionshinweise zum Orchestrator werden in drei Dokumente unterteilt: Automation Cloud und Test Cloud Automation Cloud – Öffentlicher Sektor und Test Cloud – Öffentlicher Sektor Automation Cloud Dedicated . Integration Service verfügt über einen Leitfaden mit separaten Kapiteln für Automation Cloud und Test Cloud, Automation Cloud Public Sector und Test Cloud Public Sector sowie Automation Cloud Dedicated.
	Automation Suite Test Cloud	Ein gemeinsam genutzter Dokumentationssatz für Automation Suite und Test Cloud, unabhängig von der Installationsart.	Studio Web verfügt über einen Leitfaden für die Installationen von Automation Suite und Test Cloud.
	Eigenständige Instanz	Separate Versionshinweise.	Assistant hat separate Versionshinweise für eigenständige Aktualisierungen.
Benutzerhandbuch	Automation Cloud Test Cloud	Einige Dokumentationssätze werden geteilt, während andere getrennt bleiben.	Data Service hat drei separate Benutzerhandbücher: Automation Cloud und Test Cloud Automation Cloud – Öffentlicher Sektor und Test Cloud – Öffentlicher Sektor Automatisierung – cloudgeeignet Automation Ops verfügt über ein Benutzerhandbuch, das für Automation Cloud und Test Cloud, Automation Cloud Public Sector und Test Cloud Public Sector sowie Automation Cloud Dedicated gilt.
	Automation Suite Test Cloud	Ein gemeinsam genutzter Dokumentationssatz für Automation Suite und Test Cloud.	Studio Web verfügt über ein Benutzerhandbuch für die Installationsvarianten von Automation Suite und Test Cloud.
	Eigenständige Instanz	Separate Dokumentationen.	Assistant hat ein separates Benutzerhandbuch für eigenständige Aktualisierungen.
API-Leitfaden	Automation Cloud Test Cloud	Eine gemeinsam genutzte API-Dokumentation für alle Automation Cloud- und Test Cloud-Varianten.	Die Orchestrator-API-Handbücher sind in drei Handbücher aufgeteilt: Automation Cloud und Test Cloud Automation Cloud – Öffentlicher Sektor und Test Cloud – Öffentlicher Sektor Automatisierung – cloudgeeignet
	Automation Suite Test Cloud	Eine gemeinsame API-Dokumentation für alle Installationsvarianten von Automation Suite und Test Cloud.	Orchestrator verfügt über eine API-Anleitung für die Installationsvarianten von Automation Suite und Test Cloud.
	Eigenständige Instanz	Separate Dokumentationen.	Orchestrator hat einen separaten API-Leitfaden für eigenständige Aktualisierungen.

Versionierung und Verfügbarkeit

Dokumentationsversionierung

Unsere Produktdokumentation ist systematisch nach Inhaltstypen gegliedert. Dazu gehören Installations-, Benutzer-, Administrator- und API-Handbücher sowie Versionshinweise. Die Häufigkeit der Aktualisierungen und die Versionierung der Dokumentation für jedes Produkt hängt davon ab, ob das Produkt in der Cloud oder vor Ort eingesetzt wird, wie folgt:

• Cloud: Wir aktualisieren und veröffentlichen unsere Cloud-Produktdokumentation in der Regel sofort, nachdem wir Produktänderungen für Community-Benutzer verfügbar gemacht haben.
• Lokal (On-Premises):
  • Versionen mit langfristigem Support (LTS): Wir haben eine separate Produktdokumentation für jede LTS-Version.
    Hinweis:

    Zum Beispiel haben die LTS-Versionen vom Orchestrator 2022.10 und 2023.10 jeweils ihre eigene Dokumentation.

  • Kumulative Updates (CU) und Community-Versionen: Unsere Dokumentation deckt nur die neueste CU- oder Community-Version jeder LTS-Version ab.
    Hinweis:

    Wenn beispielsweise Orchestrator 2023.10.3 die neueste CU für die LTS-Version 2023.10 ist, spiegelt unsere Dokumentation die Funktionalität der Version 2023.10.3 bis zu dem Moment wider, in dem wir die folgende CU veröffentlichen.

Nähere Informationen darüber, was sich in den einzelnen Cloud-Bereitstellungen, CU- oder LTS-Versionen geändert hat, finden Sie in den Versionshinweisen des jeweiligen Produkts.

Verfügbarkeit von Dokumentationen

Die Verfügbarkeit der Dokumentation hängt von der Entwicklungsphase des Produkts ab, das sie abdeckt, wie folgt:

• Allgemeine Verfügbarkeit (GA): Die vollständige Dokumentation für alle GA-Produkte ist auf der UiPath-Dokumentationsplattform verfügbar. Um Feedback zur GA-Dokumentation und Produkten zu geben, wenden Sie sich an das Support-Team.
• Vorschau:
  • Die Dokumentation zur privaten Vorschau finden Sie ausschließlich im Insider-Portal und ist für eine begrenzte Anzahl von Kunden verfügbar. Um Feedback zur Dokumentation und zu Produkten der privaten Vorschau zu geben, verwenden Sie das UiPath Insider-Portal.
  • Die öffentliche Vorschaudokumentation befindet sich entweder im Insider-Portal und ist für angemeldete Kunden verfügbar, oder in Ausnahmefällen auf der Dokumentationsplattform und ist für die allgemeine Zielgruppe verfügbar. Die öffentliche Vorschaudokumentation ist mit einer Beschriftung „Vorschau“ versehen. Um Feedback zur Dokumentation und zu Produkten der öffentlichen Vorschau zu geben, verwenden Sie das UiPath Insider-Portal.
  • Die Community-Dokumentation ist auf der UiPath-Dokumentationsplattform verfügbar und mit einer Beschriftung „Vorschau“ gekennzeichnet. Um ein Feedback zur Community-Dokumentation und zu -Produkten zu geben, verwenden Sie das UiPath-Forum.