好的产品文档，可胜过千军万马。文档不仅仅是产品功能和操作的简单罗列，它构建了用户与产品之间的桥梁，可以帮助用户更好地了解、规划和使用产品。

SmartX 一直将文档视作产品的重要组成部分，并通过专业的技术文档写作团队将复杂的技术语言转化为用户语言，在每个产品发布时配套发布各类产品文档（以 .pdf 离线文档形式进行分发）。为了进一步提升文档更新和流转效率，同时方便用户自助查阅，我们推出了在线的硬件兼容性查询工具、文档中心和 API 文档（主要面向开发者）。以下，我们将重点介绍这些平台和工具的特色功能，并为用户演示使用方式。

硬件兼容性查询工具

为确保 SmartX 超融合及分布式存储软件能与硬件服务器良好兼容，我们通过专业的工程团队及授信合作伙伴进行了大量的硬件兼容性测试，并将通过测试的机型与配件收录进了硬件兼容性列表（HCL）。到目前为止，共有超过 15 家硬件服务器厂商的近百种机型通过了兼容性验证，CPU 架构包括 x86_64、海光 C86、鲲鹏 AArch64 等。

通过 SmartX 硬件兼容性查询工具，用户可快速检索到目标机型及配件硬件的兼容情况，从而制定合理的采购计划。与此同时，SmartX 也保持了对该工具的持续更新，确保通过验证的新硬件能在第一时间被用户查询到。

目前，SmartX 硬件兼容性查询工具分别提供 SMTX OS 超融合软件及 SMTX ZBS 分布式存储软件的硬件兼容信息。用户可点击「链接」，或通过 SmartX 官网的产品目录栏进入该平台。

主要功能

SmartX 硬件兼容性查询工具不仅支持用户进行兼容性的查询、筛选，还方便用户将查询到的信息下载保存。

信息查询

以 SMTX OS 硬件兼容性查询工具为例，该工具的主页面分为左右两侧，左侧为机型或 CPU 平台的选择区域，右侧为兼容性配件的展示区域。

• 在工具的左侧的选择区中，用户可以优先通过 CPU 平台进行筛选，首先确认 CPU 平台的兼容性，并在同一个 CPU 平台中筛选理想的硬件服务器厂家并查看机型的兼容性。
• 用户也可以按照优先筛选服务器厂家的顺序，对同一服务器厂家不同的 CPU 平台机型进行筛选。
• 工具还支持将备注信息以更明确的方式展示出来，如：所有机型适用的通用注意事项放置在机型选择的左下方，具体机型需要注意的配件的兼容信息在查询结果页面以浮窗的形式展示（见下图演示）。

硬件兼容性查询工具操作演示

内容导出

硬件兼容性查询工具也支持导出功能，可以通过查询结果页面的右上角“导出列表”按钮，将当前查询到的兼容配件信息进行导出，用于离线查看。导出后可以通过服务器机型选择区域右上角的“重置”重新选择需要查询的其他机型信息。通过该工具导出的文件均为 .pdf 格式，表头标注了配件类型与所属机型，同时为各配件均提供了备注信息用以表明注意事项或解释说明。

导出文档示例

文档中心

线上文档中心提供了 SmartX 超融合基础设施、分布式存储、虚拟化、管理平台以及工具类产品的全部文档，目前主要对已签约的用户开放。用户可以根据产品、版本等条件查找文档，也可以根据关键字进行全文检索并跳转至目标文档。此外，用户也可以下载离线 .pdf 文档。

SmartX 提供的产品文档主要包括如下几类：

• 发布说明：一个新版本中所包含的产品功能、优化及修复问题等的说明。
• 安装部署、升级等运维管理指南：Day1、Day2 运维场景中各类操作的指南和说明。
• 管理指南：产品功能介绍及使用指南。
• 兼容性指南：客户机操作系统兼容性、硬件兼容性等。
• 技术白皮书：产品背后的技术架构、技术原理和设计理念等。
• API 文档：API、SDK 及调用示例。

如何获取

在使用文档中心前，用户需要通过 SmartX 销售代表或技术工程师开通系统账号并获取登录地址。账号开通后，用户可通过手机号及验证码登入系统。

如何使用

用户可通过顶部导航栏从产品维度查找文档，也可直接输入关键字进行全文搜索来定位目标文档。此外，用户也可以查阅已发布的、不同版本的文档，并下载 .pdf 格式的离线文档。

文档查询和下载演示

API 文档

如果您是开发者，可以直接访问 概览 | CloudTower API 查阅 API、SDK 文档，也可以通过文档中心导航栏右上角的“CloudTower API”进行跳转。

SmartX 的 API 文档主要包括如下内容：

• API 通用规范介绍，包括请求参数、返回值、鉴权、筛选、分页等。
• 各 API 的详细定义及请求和返回值示例。
• SDK 的下载方式及使用示例。
• 针对常用操作，如虚拟机生命周期管理的调用示例。
• 开发者可根据产品版本进行 API 查询，并可使用全文搜索快速定位目标 API。此外，SmartX 的 API 文档还提供离线访问方式，方便开发者在特定网络环境下进行开发。

API 文档使用演示