Sobre a documentação da UiPath

Esta seção explica como a documentação da UiPath é estruturada e como localizar as informações corretas para cada oferta, opção de entrega ou produto.

A seção é organizada nas seguintes áreas:

1. Plataformas: como navegar pela documentação para plataformas da UiPath;
2. Produtos: como localizar e usar documentação para produtos individuais da UiPath em opções de entrega;
3. Controle de versão e disponibilidade da documentação: como a documentação é agrupada e mantida.

Documentação da plataforma

A documentação da plataforma explica como instalar, configurar, administrar e atualizar ambientes da UiPath platform.

Automation Cloud e Test Cloud

A tabela a seguir agrupa a documentação por finalidade e escopo.

Tipo de documentação	Guia de documentação	Description
Notas de versão	Notas de versão do Automation Cloud	Resume as alterações no nível de plataforma para o Automation Cloud, o Automation Cloud Public Sector e o Automation Cloud Dedicated, incluindo atualizações de infraestrutura, administração e serviços compartilhados.
	Notas de versão do Test Cloud	Resume as alterações no nível de plataforma para o Test Cloud, o Test Cloud Public Sector e o Test Cloud Dedicated, incluindo atualizações de infraestrutura, administração e serviços compartilhados.
Documentação do administrador	Guia de administração do Automation Cloud	Explica como gerenciar usuários, tenants, autenticação, licenciamento e configuração do sistema para o Automation Cloud, o Automation Cloud Public Sector e o Automation Cloud Dedicated.
	Guia do administrador do Test Cloud	Explica como gerenciar usuários, tenants, autenticação, licenciamento e configuração do sistema para o Test Cloud, o Test Cloud Public Sector e o Test Cloud Dedicated.
Documentação da API	Guia de API da UiPath Automation Cloud	Descreve as APIs de plataforma disponíveis para o Automation Cloud, o Automation Cloud Public Sector e o Automation Cloud Dedicated, incluindo autenticação e interação de serviços.
	Guia da API do Test Cloud	Descreve as APIs de plataforma disponíveis para o Test Cloud, o Test Cloud Public Sector e o Test Cloud Dedicated, incluindo autenticação e interação de serviços.

Automation Suite e Test Cloud

Os guias a seguir incluem informações que são aplicáveis ao Automation Suite e ao Test Cloud, porque as plataformas compartilham a mesma arquitetura de implantação e experiência de gerenciamento. A tabela a seguir agrupa a documentação por finalidade e escopo.

Tipo de documentação	Guia de documentação	Description
Notas de versão	Notas de versão do Automation Suite	Resume as alterações no nível de plataforma para o Automation Suite e o Test Cloud, incluindo infraestrutura, administração e atualizações de serviços compartilhados.
	Notas de versão do Test Cloud para Automation Suite	Resume as alterações no nível de plataforma apenas para o Test Cloud, especificamente para atualizações relacionadas a testes.
Documentação de instalação	Guia de instalação do Automation Suite no EKS/AKS	Oferece instruções para instalar o Automation Suite ou o Test Cloud em serviços gerenciados do Kubernetes: Amazon EKS e Azure AKS.
	Guia de instalação do Automation Suite no OpenShift	Oferece instruções para instalar o Automation Suite ou o Test Cloud em clusters do Red Hat OpenShift.
	Guia de instalação do Automation Suite no Linux	Oferece instruções para instalar o Automation Suite ou o Test Cloud em ambientes Linux, de infraestrutura bare-metal a infraestrutura virtualizada no local.
Documentação do administrador	Guia do administrador do Automation Suite	Explica como gerenciar usuários, tenants, autenticação, licenciamento e configuração do sistema para o Automation Suite e o Test Cloud.
	Guia do usuário do Test Cloud	Explica como começar a usar o Test Cloud. As tarefas administrativas e a configuração da plataforma são documentadas no guia do administrador do Automation Suite, que se aplica a ambas as plataformas.
Documentação da API	Guia da API	Descreve as APIs de plataforma disponíveis para o Automation Suite e o Test Cloud, incluindo autenticação e interação de serviço.

Documentação do produto

Cada produto da UiPath inclui seu próprio conjunto de documentos, normalmente organizado por tipo de documentação. A UiPath está no processo de unificar a documentação de cloud em uma estrutura única e consistente de todas as ofertas de cloud.Para obter mais detalhes, consulte o rastreador de documentação unificada de Cloud.

Para as opções de entrega do Automation Cloud, do Automation Cloud Public Sector, do Automation Cloud Dedicated e do Automation Suite, a mesma documentação de produto aplica-se às ofertas do Test Cloud correspondentes. Como o Automation Cloud e o Automation Suite compartilham infraestrutura e arquitetura de produto com o Test Cloud, a documentação é unificada, a menos que uma funcionalidade seja explicitamente específica de um determinado tipo de plataforma.

Quando uma funcionalidade está disponível em apenas uma plataforma, a diferença é documentada de uma ou ambas as seguintes maneiras:

• Destacado nas notas de versão do produto.

• Observado na seção relevante do guia do usuário do produto.

Por exemplo, o Test Manager no Automation Cloud e o Test Cloud compartilham as mesmas notas de versão e guia do usuário. Da mesma forma, o Test Manager no Automation Suite e o Test Cloud para Automation Suite compartilham um único conjunto de documentação.

Tabela 1. Estrutura de documentação por tipo e opção de entrega

Tipo de documentação	Opções de entrega	Description	Exemplos
Notas de versão	Automation Cloud Test Cloud	Um conjunto de documentação compartilhada para o Automation Cloud e o Test Cloud. Um conjunto de documentação compartilhada para o Automation Cloud para o Setor Público e o Test Cloud para o Setor Público. Um conjunto de documentação compartilhada para o Automation Cloud Dedicado.	As notas de versão do Orchestrator são divididas em três guias: Automation Cloud e Test Cloud Automation Cloud Public Sector e Test Cloud Public Sector Automation Cloud Dedicado. O Integration Service tem um guia de notas de versão com capítulos separados para o Automation Cloud e o Test Cloud, Automation Cloud para o Setor Público e Test Cloud para o Setor Público e Automation Cloud Dedicado.
	Automation Suite Test Cloud	Um conjunto de documentação compartilhada para o Automation Suite e o Test Cloud, independentemente do tipo de instalação.	O Studio Web tem um guia de notas de versão para versões de instalação do Automation Suite e do Test Cloud.
	Versão independente	Conjunto de notas de versão separadas.	O Assistant tem um guia de notas de versão separado para atualizações independentes.
Guia do Usuário	Automation Cloud Test Cloud	Alguns conjuntos de documentação são compartilhados, enquanto outros permanecem separados.	O Data Service tem três guias de usuário separados: Automation Cloud e Test Cloud Automation Cloud Public Sector e Test Cloud Public Sector Automation Cloud dedicado O Automation Ops tem um guia do usuário que se aplica ao Automation Cloud e Test Cloud, Automation Cloud para o Setor Público e Test Cloud para o Setor Público e Automation Cloud Dedicado.
	Automation Suite Test Cloud	Um conjunto de documentação compartilhada para o Automation Suite e o Test Cloud.	O Studio Web tem um guia do usuário para os tipos de instalação do Automation Suite e do Test Cloud.
	Versão independente	Conjuntos de documentação separados.	O Assistant tem um guia do usuário separado para atualizações independentes.
Guia da API	Automation Cloud Test Cloud	Um conjunto de documentação de API compartilhada para todos os tipos de Automation Cloud e Test Cloud.	Os guias de API do Orchestrator são divididos em três guias: Automation Cloud e Test Cloud Automation Cloud Public Sector e Test Cloud Public Sector Automation Cloud dedicado
	Automation Suite Test Cloud	Um conjunto de documentação de API compartilhada para todos os tipos de instalação do Automation Suite e do Test Cloud.	O Orchestrator tem um guia de API para tipos de instalação do Automation Suite e do Test Cloud.
	Versão independente	Conjuntos de documentação separados.	O Orchestrator tem um guia de API separado para atualizações independentes.

Controle de versão e disponibilidade

Controle de versão de documentação

Nossa documentação de produtos é dividida sistematicamente com base no tipo de conteúdo, que inclui guias de instalação, usuário, administrador e API, bem como notas de versão. A frequência de atualização e o controle de versão da documentação para cada produto dependem se o produto é implantado na nuvem ou no local, da seguinte forma:

• Cloud: normalmente atualizamos e publicamos nossa documentação de produto de cloud imediatamente após disponibilizar as alterações no produto para usuários da comunidade.

• No local:

  • Versões de suporte em longo prazo (LTS): temos um conjunto separado de documentação de produtos para cada versão LTS.
    Observação: por exemplo, as versões 2022.10 e 2023.10 LTS do Orchestrator têm cada uma seu conjunto exclusivo de documentação.
  • Atualizações cumulativas (UC) e versões Community: nossa documentação abrange apenas a versão mais recente da CU ou Community de cada versão LTS.
    Observação: por exemplo, se o Orchestrator 2023.10.3 for a CU mais recente para a versão 2023.10 LTS, nossa documentação reflete a funcionalidade da versão 2023.10.3 até o momento em que lançamos o seguinte CU.

Para obter detalhes sobre o que mudou em cada implantação de nuvem, CU ou LTS, consulte as notas de versão de cada produto.

Disponibilidade de Documentação

A disponibilidade da documentação depende da fase de desenvolvimento do produto que ela cobre, da seguinte forma:

• Disponibilidade geral (GA - General Availability): A documentação completa para todos os produtos GA está disponível na plataforma de documentação da UiPath.Para compartilhar feedback sobre a documentação e produtos GA, entre em contato com a equipe de suporte.

• Pré-visualização:

  • A documentação de pré-visualização privada é encontrada exclusivamente no Portal do Insider e está disponível para um número limitado de clientes. Para compartilhar feedback sobre documentação de pré-visualização privada e produtos, use o Portal do UiPath Insider.
  • A documentação de pré-visualização pública é encontrada no Portal do Insider e está disponível para clientes conectados ou excepcionalmente na plataforma de documentação e está disponível para o público em geral. A documentação de pré-visualização pública é marcada com um rótulo Pré-visualização. Para compartilhar feedback sobre documentação de pré-visualização pública e produtos, use o Portal do UiPath Insider.
  • A documentação Community está disponível na plataforma de documentação da UiPath e é marcada com um rótulo Pré-visualização. Para compartilhar feedback sobre a documentação e produtos Community, use o fórum da UiPath.