Контент Get Start предоставляет точку входа в использование продуктов и функций GitHub. Этот раздел должен содержать только минимально необходимую информацию, необходимую пользователю, прежде чем перейти к концепциям и инструкциям. Мы делаем это, чтобы быть краткими и чтобы не казалось сложным просто начать с фильма.
Вопросы для начала
Get Start — это набор статей, которые легко и быстро сканировать. В нём должно быть меньше 5 статей, а в идеале — только две:
- Быстрый старт
- О [ПРОДУКТЕ] (или «Что такое [ПРОДУКТ]»)
Единственное исключение может быть с доступными планами и информацией о выставлении счетов, когда такая информация требуется для использования продукта или функции.
Для получения дополнительной информации о контенте быстрого запуска см. Тип контента быстрого запуска.
В частности, статьи с такой информацией не подходят для раздела «Начать»:
- Статьи, относящиеся к типу «обучающее».
- Шаги настройки или регистрации: это тоже инструкции. Они документируют, как что-то делать в интерфейсе.
- Контент, который полезен для начала работы с определённой функцией, но не для всей продуктовой области. Такой контент более уместно относится к концепциям.
- Лучшие практики, в целом. Пользователи, впервые знакомящиеся с функцией, не имеют необходимого контекста, чтобы максимально эффективно использовать эти функции.