使用一句话概括本文档的目的、受众和主要内容。例如:本文档帮助新用户快速了解和使用 XXX 功能。
给用户一个简单的场景,让用户知道此文档在做什么,可以解决什么问题。
预计完成本文档的阅读和操作时间,例如:10-15 分钟。
提醒用户阅读文档前应该注意的事项,例如:权限要求、使用限制、重要提醒、可能的风险等。
用户在阅读文档前需要做的准备工作,例如:基础知识储备、环境要求、软件版本、硬件配置、网络要求等。
针对流程概述中的每个步骤,进行详细说明。
开篇使用一个段落概述该操作,让用户能够了解该操作涉及到的功能的基本概念。
在段落下使用有序列表,列出该操作的详细配置步骤。
...
开篇使用一个段落概述该操作,让用户能够了解该操作涉及到的功能的基本概念。
在段落下使用有序列表,列出该操作的详细配置步骤。
为帮助用户更好地理解整个流程和功能,使用下述一种或多种方式展示预期结果: