关于 UiPath 文档

本节介绍 UiPath 文档的结构，以及如何查找各项服务、交付选项或产品的相应信息。

本节分为以下区域：

1. 平台：如何导航 UiPath 平台的文档；
2. 产品：如何在交付选项中查找和使用各个 UiPath 产品的文档；
3. 文档版本控制和可用性：如何对文档进行分组和维护。

平台文档

平台文档介绍了如何安装、配置、管理和升级 UiPath Platform 环境。

Automation Cloud 和 Test Cloud

The following table groups documentation by purpose and scope.

文档类型	文档指南	描述
发行说明	Automation Cloud 发行说明	Summarizes platform-level changes for Automation Cloud, Automation Cloud Public Sector, and Automation Cloud Dedicated, including infrastructure, administration, and shared services updates.
	Test Cloud 发行说明	Summarizes platform-level changes for Test Cloud, Test Cloud Public Sector, and Test Cloud Dedicated, including infrastructure, administration, and shared services updates.
管理员文档	Automation Cloud 管理员指南	Explains how to manage users, tenants, authentication, licensing, and system configuration for Automation Cloud, Automation Cloud Public Sector, and Automation Cloud Dedicated.
	Test Cloud 管理员指南	Explains how to manage users, tenants, authentication, licensing, and system configuration for Test Cloud,Test Cloud Public Sector, and Test Cloud Dedicated.
API 文档	Automation Cloud API 指南	Describes the available platform APIs for Automation Cloud, Automation Cloud Public Sector, and Automation Cloud Dedicated, including authentication and service interaction.
	Test Cloud API 指南	Describes the available platform APIs for Test Cloud, Test Cloud Public Sector, and Test Cloud Dedicated, including authentication and service interaction.

Automation Suite 和 Test Cloud

以下指南包含适用于 Automation Suite 和 Test Cloud 的信息，因为这两个平台共享相同的部署架构和管理体验。 下表按用途和作用域对文档进行分组。

文档类型	文档指南	描述
发行说明	Automation Suite 发行说明	汇总 Automation Suite 和 Test Cloud 的平台级别更改，包括基础架构、管理和共享服务更新。
	Test Cloud for Automation Suite 发布说明	汇总仅针对 Test Cloud 的平台级别更改，特别是针对与测试相关的更新。
安装文档	EKS/AKS 上的 Automation Suite 安装指南	提供在托管 Kubernetes 服务（Amazon EKS 和 Azure AKS）上安装 Automation Suite 或 Test Cloud 的说明。
	OpenShift 上的 Automation Suite 安装指南	提供有关在 Red Hat OpenShift 集群上安装 Automation Suite 或 Test Cloud 的说明。
	Linux 版 Automation Suite 安装指南	提供有关在 Linux 环境中安装 Automation Suite 或 Test Cloud 的说明，从裸机基础架构到本地虚拟化基础架构。
管理员文档	Automation Suite 管理页指南	解释如何管理 Automation Suite 和 Test Cloud 的用户、租户、身份验证、许可和系统配置。
	Test Cloud 用户指南	解释如何开始使用 Test Cloud。 管理任务和平台配置记录在《Automation Suite 管理员指南》中，该指南适用于两个平台。
API 文档	API 指南	描述 Automation Suite 和 Test Cloud 的可用平台 API，包括身份验证和服务交互。

产品文档

每个 UiPath 产品都包含自己的文档集，通常按文档类型组织。 UiPath 正在将所有 Cloud 产品的 Cloud 文档整合为统一、一致的结构。有关更多详细信息，请参阅“统一 Cloud 文档跟踪器”。

For the delivery options Automation Cloud, Automation Cloud Public Sector, Automation Cloud Dedicated, and Automation Suite, the same product documentation applies to the corresponding Test Cloud offerings. Because Automation Cloud and Automation Suite share infrastructure and product architecture with Test Cloud, documentation is unified unless a feature is explicitly specific to a certain platform type.

当功能仅在一个平台上可用时，差异将通过以下一种或两种方式记录：

• 在产品发布说明中突出显示。

• 在《产品用户指南》的相关部分中注明。

例如，Automation Cloud 中的 Test Manager 和 Test Cloud 共享相同的发布说明和用户指南。 同样，Automation Suite 中的 Test Manager 和 Test Cloud for Automation Suite 共享单个文档集。

表 1. 按类型和交付选项划分的文档结构

文档类型	传递选项	描述	示例
发行说明	Automation Cloud Test Cloud	一个用于 Automation Cloud 和 Test Cloud 的共享文档集。 一个用于 Automation Cloud 公共部门和 Test Cloud 公共部门的共享文档集。 一个 Automation Cloud (专属) 共享文档集。	Orchestrator 发布说明分为三个指南： Automation Cloud 和 Test Cloud Automation Cloud 公共部门和 Test Cloud 公共部门 Automation Cloud (专属) Integration Service 有一个发布说明指南，其中包含有关 Automation Cloud 和 Test Cloud、Automation Cloud 公共部门和 Test Cloud 公共部门以及 Automation Cloud (专属)的独立章节。
	Automation Suite Test Cloud	一个适用于 Automation Suite 和 Test Cloud 的共享文档集，无论安装风格如何。	Studio Web 有一个针对 Automation Suite 和 Test Cloud 安装风格的发布说明指南。
	单机版	单独设置发布说明。	Assistant 具有单独的独立更新发布说明指南。
用户指南	Automation Cloud Test Cloud	某些文档集是共享的，而其他文档集则保持独立。	Data Service 有三个独立的用户指南： Automation Cloud 和 Test Cloud Automation Cloud 公共部门和 Test Cloud 公共部门 Automation Cloud 专用 Automation Ops 有一个用户指南，适用于 Automation Cloud 和 Test Cloud、Automation Cloud 公共部门和 Test Cloud 公共部门以及 Automation Cloud (专属)。
	Automation Suite Test Cloud	一个用于 Automation Suite 和 Test Cloud 的共享文档集。	Studio Web 有一个用于安装 Automation Suite 和 Test Cloud 的用户指南。
	单机版	单独的文档集。	Assistant 具有独立更新的单独用户指南。
API 指南	Automation Cloud Test Cloud	一个共享 API 文档集，适用于所有 Automation Cloud 和 Test Cloud 版本。	Orchestrator API 指南分为三个指南： Automation Cloud 和 Test Cloud Automation Cloud 公共部门和 Test Cloud 公共部门 Automation Cloud 专用
	Automation Suite Test Cloud	一个共享 API 文档集，适用于所有 Automation Suite 和 Test Cloud 安装风格。	Orchestrator 有一个 Automation Suite 和 Test Cloud 安装风格的 API 指南。
	单机版	单独的文档集。	Orchestrator 拥有一个独立更新的单独 API 指南。

版本控制和可用性

文档版本控制

我们的产品文档根据内容类型进行系统划分，其中包括安装、用户、管理和 API 指南以及发行说明。每个产品文档的更新频率和版本控制取决于该产品是在云端部署还是本地部署，如下所示：

• Cloud：我们通常在向社区用户提供产品更改后，立即更新和发布我们的 Cloud 产品文档。

• 本地部署：

  • 长期支持 (LTS) 版本：我们为每个 LTS 版本都配备有一组单独的产品文档。
    注意：例如，Orchestrator 2022.10 和 2023.10 LTS 版本都有其唯一的文档集。
  • 累积更新 (CU) 和社区版本：我们的文档仅涵盖每个 LTS 版本的最新 CU 或社区版本。
    注意：例如，如果 Orchestrator 2023.10.3 是 2023.10 LTS 版本的最新 CU，则在我们发布以下 CU 之前，我们的文档反映的是 2023.10.3 版本的功能。

有关每个云部署、CU 或 LTS 版本中更改的详细信息，请查看每个产品的发行说明。

文档可用性

文档是否可用取决于其所涵盖产品的开发阶段，如下所示：

• 正式发布 (GA)：UiPath 文档平台上提供了所有 GA 产品的完整文档。如需共享有关 GA 文档和产品的反馈，请联系支持团队。

• 预览：

  • 个人预览版文档仅位于内部人员门户上，并且可供有限数量的客户使用。要分享对个人预览文档和产品的反馈，请使用 UiPath 预览体验成员门户。
  • 公开预览的文档可在内部人员门户上找到，可供登录的客户使用，也可在文档平台上找到，供公众使用。公开预览文档标有“预览”标签。要分享对公共预览文档和产品的反馈，请使用 UiPath 预览体验成员门户。
  • 您可以在 UiPath 文档平台上使用社区文档，并且该类文档标有“预览”标签。要分享有关社区文档和产品的反馈，请使用 UiPath 论坛。