快速开始

使用一句话概括本文档的目的、受众和主要内容。例如:本文档帮助新用户快速了解和使用 XXX 功能。

介绍

适用场景

给用户一个简单的场景,让用户知道此文档在做什么,可以解决什么问题。

预计阅读时间

预计完成本文档的阅读和操作时间,例如:10-15 分钟。

注意事项(可选)

提醒用户阅读文档前应该注意的事项,例如:权限要求、使用限制、重要提醒、可能的风险等。

前提条件(可选)

用户在阅读文档前需要做的准备工作,例如:基础知识储备、环境要求、软件版本、硬件配置、网络要求等。

流程概述

  • 使用表格的方式列出用户需要执行的操作步骤,让用户了解整个流程。列表中需包括:
    • 序号:从 1 开始,依次递增。
    • 操作步骤:用户需要执行的操作步骤,所有的操作步骤需能够组合成一个完整的流程,让用户从宏观上了解功能,以及直观看到最终可以获得怎样的结果。
    • 描述:操作步骤的描述,需要简洁明了,让用户能够快速理解。

操作步骤

针对流程概述中的每个步骤,进行详细说明。

操作步骤 1

  • 开篇使用一个段落概述该操作,让用户能够了解该操作涉及到的功能的基本概念。

  • 在段落下使用有序列表,列出该操作的详细配置步骤。

...

操作步骤 N

  • 开篇使用一个段落概述该操作,让用户能够了解该操作涉及到的功能的基本概念。

  • 在段落下使用有序列表,列出该操作的详细配置步骤。

预期结果(标题需要根据实际情况调整)

为帮助用户更好地理解整个流程和功能,使用下述一种或多种方式展示预期结果:

  • 功能概述:通过文字描述主要特点和用途。
  • 图片展示:通过为文档增加图片,可视化展示结果。
  • 步骤列表:通过步骤详细列举操作流程。