À propos de la documentation UiPath

Cette section explique comment la documentation d'UiPath est structurée et comment trouver les bonnes informations pour chaque offre, option de livraison ou produit.

La section est organisée dans les zones suivantes :

1. Plateformes : comment naviguer dans la documentation des plateformes UiPath ;
2. Produits : comment trouver et utiliser la documentation des produits UiPath individuels dans les options de livraison.
3. Contrôle des versions et disponibilité de la documentation : comment la documentation est regroupée et maintenue.

Documentation de la plateforme

La documentation de la plateforme explique comment installer, configurer, administrer et mettre à niveau les environnements de plateforme UiPath.

Automation Cloud et Test Cloud

Le tableau suivant regroupe la documentation par objectif et par étendue.

Type de documentation	Guide de documentation	Description
Notes de publication	Notes de publication d'Automation Cloud	Résume les modifications au niveau de la plateforme pour Automation Cloud, Automation Cloud Secteur Public et Automation Cloud (Dédié), y compris les mises à jour de l'infrastructure, de l'administration et des services partagés.
	Notes de publication de Test Cloud	Résume les modifications au niveau de la plateforme pour Test Cloud, Test Cloud Secteur Public et Test Cloud Dédié, y compris les mises à jour de l'infrastructure, de l'administration et des services partagés.
Documentation de l'administrateur	Guide d'administration d'Automation Cloud	Explique comment gérer les utilisateurs, les locataires, l'authentification, la concession de licences et la configuration du système pour Automation Cloud, Automation Cloud Secteur Public et Automation Cloud (Dédié).
	Guide de l'administrateur de Test Cloud	Explique comment gérer les utilisateurs, les locataires, l'authentification, la concession de licences et la configuration du système pour Test Cloud, Test Cloud Secteur Public et Test Cloud Dédié.
Documentation de l'API	Guide d'administration d'Automation Cloud	Décrit les API de plateforme disponibles pour Automation Cloud, Automation Cloud Secteur Public et Automation Cloud (Dédié), y compris l'authentification et l'interaction du service.
	Guide de l'API Test Cloud	Décrit les API de plateforme disponibles pour Test Cloud, Test Cloud Secteur Public et Test Cloud dédié, y compris l'authentification et l'interaction du service.

Automation Suite et Test Cloud

Les guides suivants incluent des informations qui sont applicables à la fois à Automation Suite et Test Cloud, car les plateformes partagent la même architecture de déploiement et la même expérience de gestion. Le tableau suivant regroupe la documentation par objectif et par étendue.

Type de documentation	Guide de documentation	Description
Notes de publication	Notes de publication d'Automation Suite	Résume les modifications au niveau de la plateforme à la fois pour Automation Suite et Test Cloud, y compris les mises à jour de l'infrastructure, de l'administration et des services partagés.
	Notes de version de Test Cloud pour Automation Suite	Résume les modifications au niveau de la plateforme pour Test Cloud uniquement, en particulier pour les mises à jour liées aux tests.
Documentation d'installation	Guide d'installation d'Automation Suite sur EKS/AKS	Offre des instructions pour l'installation d'Automation Suite ou de Test Cloud sur les services Kubernetes gérés : Amazon EKS et Azure AKS.
	Guide d'installation d'Automation Suite sur OpenShift	Offre des instructions pour l'installation d'Automation Suite ou de Test Cloud sur les clusters Red Hat OpenShift.
	Guide d'installation d'Automation Suite sur Linux	Fournit des instructions pour l'installation d'Automation Suite ou de Test Cloud dans les environnements Linux, de l'infrastructure bare-metal à l'infrastructure virtualisée sur site.
Documentation de l'administrateur	Guide d'administration d'Automation Suite	Explique comment gérer les utilisateurs, les locataires, l'authentification, la concession de licence et la configuration du système à la fois pour Automation Suite et pour Test Cloud.
	Guide de l'utilisateur Test Cloud	Explique comment commencer à utiliser Test Cloud. Les tâches administratives et la configuration de la plateforme sont documentées dans le guide de l'administrateur d'Automation Suite, qui s'applique aux deux plateformes.
Documentation de l'API	Guide de l’API	Décrit les API de plateforme disponibles pour Automation Suite et Test Cloud, y compris l'authentification et l'interaction du service.

Documentation du produit

Chaque produit UiPath inclut son propre ensemble de documentation, généralement organisé par type de documentation. UiPath est en train d'unifier la documentation Cloud en une seule structure cohérente dans toutes les offres Cloud. Pour de plus amples détails, consultez le suivi de la documentation du Cloud unifié.

Pour les options de livraison Automation Cloud, Automation Cloud Secteur Public, Automation Cloud (Dédié) et Automation Suite, la même documentation du produit s'applique aux offres Test Cloud correspondantes. Étant donné qu'Automation Cloud et Automation Suite partagent une infrastructure et une architecture de produit avec Test Cloud, la documentation est unifiée, à moins qu'une fonctionnalité ne soit explicitement spécifique à un certain type de plateforme.

Lorsqu'une fonctionnalité est disponible sur une seule plateforme, la différence est documentée de l'une des façons suivantes ou des deux :

• Mis en surbrillance dans les notes de version du produit.
• Noté dans la section pertinente du guide de l'utilisateur du produit.

Par exemple, Test Manager dans Automation Cloud et Test Cloud partagent les mêmes notes de version et le même guide de l'utilisateur. De même, Test Manager dans Automation Suite et Test Cloud pour Automation Suite partagent un seul ensemble de documentation.

Tableau 1. Structure de la documentation par type et par option de livraison

Type de documentation	Option de livraison	Description	Exemples
Notes de publication	Automation Cloud Test Cloud	Un ensemble de documentation partagé pour Automation Cloud et Test Cloud. Un ensemble de documentation partagé pour Automation Cloud Secteur public et Test Cloud Secteur public. Un ensemble de documentation partagé pour Automation Cloud (Dédié).	Les notes de version d'Orchestrator sont divisées en trois guides : Automation Cloud et Test Cloud Automation Cloud pour le secteur public et Test Cloud pour le secteur public Automation Cloud (Dédié) . Integration Service dispose d'un guide des notes de version avec des chapitres distincts pour Automation Cloud et Test Cloud, Automation Cloud Secteur public et Test Cloud Secteur public, et Automation Cloud Dédié.
	Automation Suite Test Cloud	Un ensemble de documentation partagé pour Automation Suite et Test Cloud, quel que soit le type d'installation.	Studio Web dispose d'un guide de notes de version pour les types d'installation d'Automation Suite et de Test Cloud.
	Version autonome	Un ensemble de notes de version distinct.	Assistant dispose d'un guide des notes de version distinct pour les mises à jour autonomes.
Manuel utilisateur	Automation Cloud Test Cloud	Certains ensembles de documentation sont partagés tandis que d'autres restent distincts.	Data Service dispose de trois guides utilisateur distincts : Automation Cloud et Test Cloud Automation Cloud pour le secteur public et Test Cloud pour le secteur public Cloud d'automatisation dédié Automation Ops dispose d'un guide de l'utilisateur qui s'applique à Automation Cloud et à Test Cloud, à Automation Cloud Secteur public et Test Cloud Secteur public ainsi qu'à Automation Cloud (Dédié).
	Automation Suite Test Cloud	Un ensemble de documentation partagé pour Automation Suite et Test Cloud.	Studio Web dispose d'un guide de l'utilisateur pour les types d'installation d'Automation Suite et de Test Cloud.
	Version autonome	Ensembles de documentation distincts.	Assistant dispose d'un guide de l'utilisateur distinct pour les mises à jour autonomes.
Guide de l’API	Automation Cloud Test Cloud	Un ensemble de documentation d'API partagé pour tous les types d'Automation Cloud et de Test Cloud.	Les guides d'API Orchestrator sont divisés en trois guides : Automation Cloud et Test Cloud Automation Cloud pour le secteur public et Test Cloud pour le secteur public Cloud d'automatisation dédié
	Automation Suite Test Cloud	Un ensemble de documentation d'API partagé pour toutes les saveurs d'installation d'Automation Suite et Test Cloud.	Orchestrator dispose d'un guide d'API pour les saveurs d'installation d'Automation Suite et Test Cloud.
	Version autonome	Ensembles de documentation distincts.	Orchestrator dispose d'un guide d'API distinct pour les mises à jour autonomes.

Contrôle de version et disponibilité

Contrôle de version de la documentation

Notre documentation produit est systématiquement divisée en fonction du type de contenu. Cela inclut des guides d’installation, d’utilisation, d’administration et d’API, ainsi que des notes de version. La fréquence des mises à jour et le contrôle des versions de la documentation dépendront pour chaque produit du déploiement du produit (version cloud ou version locale), comme suit :

• Cloud: nous mettons généralement à jour et publions la documentation de notre produit Cloud immédiatement après avoir mis les modifications du produit à la disposition des utilisateurs de la communauté.
• Version locale :
  • Versions d’assistance longue durée (LTS) : nous disposons d’un ensemble de documentation produit distinct pour chaque version LTS.
    Remarque :

    Par exemple, les versions LTS d’Orchestrator 2022.10 et 2023.10 disposent chacune d’un ensemble de documentation spécifique.

  • Mises à jour cumulatives (CU) et versions Community : notre documentation couvre uniquement la dernière version CU ou Community de chaque version LTS.
    Remarque :

    Par exemple, si Orchestrator 2023.10.3 constitue la dernière version CU de la version LTS 2023.10, notre documentation rendra compte des fonctionnalités de la version 2023.10.3 jusqu’à la publication de la version CU suivante.

Pour plus de détails sur les modifications appliquées à l’occasion de chaque déploiement cloud, CU ou LTS, consultez les notes de publication de chaque produit.

Disponibilité de la documentation

La disponibilité de la documentation dépend de la phase de développement du produit concerné, comme suit :

• Disponibilité générale: la documentation complète de tous les produits GA est disponible sur la plateforme de documentation UiPath. Pour envoyer vos commentaires sur la documentation et les produits en disponibilité générale, contactez l’équipe d’assistance.
• Aperçu :
  • La documentation en aperçu privé est disponible exclusivement sur le portail UiPath Insider Portal et pour un nombre limité de clients. Pour partager des commentaires sur la documentation et les produits en aperçu privé, utilisez le portail UiPath Insider Portal.
  • La documentation en aperçu public est disponible sur le portail UiPath Insider Portal pour les clients connectés, voire de façon exceptionnelle sur la plate-forme de documentation et pour le grand public. La documentation en aperçu public est signalée par une libellé « Aperçu ». Pour partager des commentaires sur la documentation et les produits en aperçu public, utilisez le portail UiPath Insider Portal.
  • La documentation Community est disponible sur la plate-forme de documentation UiPath et signalée par le libellé « Aperçu ». Pour partager des commentaires sur la documentation et les produits Community, utilisez le UiPath Forum.