У цьому матеріалі
Перед початком
- Ця функція створена для сайтів типу Help Center та Product Docs. Вона ввімкнена за замовчуванням для початкового шаблону Software або SaaS. Сайти інших типів не можуть її додати.
- Вам потрібні права на керування довідковим центром.
Кроки
- Відкрийте Матеріали і виберіть Нотатки про випуск. Це відкриє список приміток до випусків.
- Натисніть Нове.
- Заповніть Заголовок,
versionіreleasedOn— дату виходу версії. Ці три поля є обов'язковими. - Необов'язково: Короткий зміст (до 1000 символів) та Посилання на детальнішу сторінку.
- Додайте по рядку для кожної зміни у полі списку. У цій формі цей список позначено як Моменти. Виберіть тип Тип: Нове, Покращено або Виправлено. Введіть текст довжиною до 300 символів. Можна додати до 100 рядків.
- Додайте примітку до розділу потрібного хабу, а потім опублікуйте.
У формі ці допоміжні поля показані короткими назвами, наприклад version та releasedOn, замість повних речень.
Варто знати
- Порядок. Примітки сортуються за датою виходу — найновіші спочатку.
- Окремо для кожного хабу. На сторінці хабу відображаються лише примітки з його розділу та тем.
- RSS. Читачі можуть стежити за списком змін через стрічку новин. Вона доступна на вашому сайті за адресою, що закінчується на /help/release-notes.rss.
- Дані для пошуку. Кожна примітка передається пошуковим системам як технічна стаття із зазначенням версії. Спеціальне відображення в пошуку не гарантується.
- Пишіть для клієнтів. Пояснюйте простими словами, що саме змінилося для користувача.
Питання
Часті запитання
Чи можна запланувати публікацію примітки до випуску?
Так. Примітки до випуску працюють так само, як і публікації, тому ви можете відкласти їхню появу на потім.
Що робити з проблемами, які ще не виправлено?
Скористайтеся розділом Known issues and notices.