Перейти к основному содержанию
Опишите, как кто-то начинает использовать ваш продукт. Что нужно сделать в первую очередь? Есть ли какие-либо предварительные требования? Быстрый старт должен провести человека от нуля до использования вашего продукта. Он получит быструю победу и понимание того, чего можно достичь.

​
Предварительные требования

Прежде чем начать, у вас должно быть:
  • Требование первое (например, Node.js 18+, бесплатная учётная запись, API-ключ)
  • Требование второе (например, совместимое устройство, совместимый браузер, совместимая операционная система)

​
Приступаем

1

Установка

Опишите, как установить ваш продукт или зарегистрироваться.
npm install your-package
2

Настройка

Опишите любую настройку или конфигурацию, необходимую перед первым использованием.
your-cli init
3

Запуск

Покажите первое действие, которое пользователь выполняет, чтобы увидеть результат.
your-cli start
Дайте людям возможность получить помощь. Это может быть ссылка на страницу поддержки, чат со специалистом по поддержке клиентов или форум для вашего продукта.Пример: Нужна помощь? Свяжитесь с нами по адресу support@yourcompany.com.