跳转到主要内容
描述用户如何开始使用您的产品。他们首先需要做什么?是否有任何先决条件? 快速开始应帮助用户从零开始上手您的产品。他们将获得一次快速的成功体验,并对能够实现的目标有所了解。

先决条件

开始之前,您必须具备:
  • 要求一(例如,Node.js 18+、免费账户、API 密钥)
  • 要求二(例如,兼容的设备、兼容的浏览器、兼容的操作系统)

开始使用

1

安装

描述如何安装您的产品或注册。
npm install your-package
2

配置

描述首次使用前所需的任何设置或配置。
your-cli init
3

运行

展示用户为查看效果所做的第一件事。
your-cli start
为用户提供获取帮助的方式。这可以是支持页面的链接、与客服代理的聊天,或您产品的论坛。示例:需要帮助?请通过 support@yourcompany.com 联系我们。