В этой истории
Перед началом
- Эта функция создана для сайтов Help Center и Product Docs. Она включена по умолчанию для отправной точки Software или SaaS. Сайт другого типа не может добавить ее.
- Вам требуется разрешение на управление справочным центром.
Инструкция
- Откройте Материалы и выберите История версий. Откроется список примечаний к выпуску.
- Выберите Новые.
- Заполните Заголовок,
versionиreleasedOn— дату выхода версии. Эти три поля обязательны. - Необязательно: Краткое описание, до 1 000 символов, и Ссылка на более подробную страницу.
- Добавьте по одной строке для каждого изменения в поле списка. В этой форме список показан как Ключевые моменты. Выберите его Тип: Новые, Улучшено или Исправлено. Напишите текст длиной до 300 символов. Вы можете добавить до 100 строк.
- Поместите примечание в раздел нужного хаба, затем опубликуйте.
Форма показывает эти вспомогательные поля под их краткими именами, такими как version и releasedOn, вместо полных предложений.
Полезно знать
- Порядок. Примечания выводятся в порядке от самых новых дат выпуска к старым.
- Для каждого хаба. Страница хаба перечисляет примечания из своего раздела и тем.
- RSS. Читатели могут следить за журналом изменений через ленту. Лента находится по адресу, оканчивающемуся на /help/release-notes.rss на вашем сайте.
- Данные для поиска. Каждое примечание описывается поисковым системам как техническая статья с указанием версии. Ничто не гарантирует специальное отображение в поиске.
- Пишите для читателя. Рассказывайте простыми словами, что именно изменилось для них.
Вопросы
Часто задаваемые вопросы
Могу ли я запланировать публикацию примечания к выпуску?
Да. Примечания к выпуску — это такие же записи, как истории, поэтому вы можете опубликовать их позже.
Как быть с неполадками, которые еще не устранены?
Используйте Known issues and notices.