Как сделать страницу обновлений: записи, теги, RSS и «Что нового»

Страница чейнджлога — это список изменений продукта по датам, от новых к старым, написанный для тех, кто им пользуется. Чтобы её сделать, нужны записи с датой, понятным заголовком, коротким объяснением и тегом (Новое, Улучшено, Исправлено), страница, которая их выводит, отдельный URL для каждой записи и, желательно, RSS-лента и способ сообщить пользователям, что появилось новое. Это одна из самых простых вещей, которые можно построить. Главное решение — где хранить записи: файлами на сайте или в базе данных с административной страницей.

Зачем нужен чейнджлог

Чейнджлог показывает клиентам и потенциальным покупателям, что продукт поддерживается. Он даёт поддержке и продажам ссылку, которую можно отправить, когда спрашивают «а это уже умеет?». Кроме того, это способ закрыть цикл обратной связи: когда запрошенная функция выходит, именно на запись в чейнджлоге вы и указываете людям. Если вы ведёте портал обратной связи от клиентов, ссылайте выпущенные запросы прямо на их записи.

Чейнджлог — это не внутренняя история коммитов. «Рефакторинг сервиса биллинга» ничего не говорит пользователю. «Теперь на счетах отображается ИНН вашей компании» — говорит.

Что нужно странице

Содержимое каждой записи

Страницы

• Индекс чейнджлога: от новых к старым, с фильтрами по тегам и простой пагинацией или кнопкой «Показать ещё».
• Страница записи: одна запись — один URL, чтобы её можно было открыть по ссылке и поделиться.
• RSS- или Atom-лента: позволяет людям и сервисам следить за обновлениями без почтовой рассылки.
• Административная страница (только в версии с базой данных): писать, предпросматривать, планировать и публиковать записи.

Дополнения в приложении

• Значок «Что нового»: точка у пункта меню, когда есть записи, которые пользователь ещё не видел. Храните дату последней открытой им записи — для каждого пользователя или в браузере.
• Дайджест по почте: сводка, которую получают пользователи, давшие согласие. Для этого нужен провайдер отправки; см. как отправлять письма из приложения.

Главное решение: файлы или база данных

Записи как файлы на сайте

Каждая запись — это Markdown-файл в проекте. Чтобы опубликовать запись, вы добавляете файл и выкладываете сайт заново. Это самый простой и надёжный подход: без базы данных, без входа в админку, нечего защищать, а страницы можно отрисовать заранее, так что они быстро загружаются и легко читаются поисковиками.

Он подходит командам, где люди, пишущие записи, готовы попросить ИИ-конструктор или отредактировать файл.

Записи в базе данных с административной страницей

Записи хранятся в таблице, а закрытая админ-страница позволяет всем в команде писать, предпросматривать, планировать и публиковать. Это подходит командам, где обновления пишут маркетинг или поддержка, или когда нужна публикация по расписанию или записи для разных аудиторий (например, функции для корпоративных клиентов показываются только им).

Цена — больше работы и обслуживания: вход в админку, загрузка изображений и то, чтобы публичные страницы оставались читаемыми для поисковиков, а страница, которая загружает записи только в браузере, может этого не обеспечить.

Как писать записи, которые читают

• Начинайте с пользы. «Экспорт отчётов в Excel» лучше, чем «Новый модуль экспорта».
• Скажите, кому это доступно. Все тарифы, только Pro, выкатываем на этой неделе.
• Покажите. Один скриншот или короткое видео.
• Группируйте мелочи. Еженедельная запись «Исправления и улучшения» с пунктами не даст странице захлебнуться.
• Будьте честны с удалением. Если что-то уходит, скажите когда и чем это заменить.

Пример первого промпта

Добавь публичный чейнджлог на наш сайт по адресу /changelog. Каждая запись — Markdown-файл с заголовком, датой, тегом (Новое, Улучшено или Исправлено), необязательным обложечным изображением и текстом. Страница-индекс выводит записи от новых к старым с датой, тегом и первым абзацем, имеет кнопки фильтра по тегам и показывает по 10 записей на страницу. У каждой записи своя страница по адресу /changelog/<slug> с понятным заголовком и описанием для поисковиков. Добавь RSS-ленту по адресу /changelog/rss.xml. Создай три примера записей. Сделай в стиле текущего сайта, удобно на телефонах, и заранее отрисовывай страницы, чтобы они быстро загружались.

Для версии с базой данных замените первое предложение на «Храни записи в базе данных со статусом черновика или опубликовано и датой публикации, и добавь защищённую паролем админ-страницу, чтобы писать, предпросматривать и публиковать записи».

Шаги сборки

1. Решите, файлы или база данных, по таблице выше.
2. Постройте страницы индекса и записи с несколькими примерами.
3. Добавьте теги и фильтры.
4. Добавьте RSS-ленту и ссылку на неё со страницы.
5. Добавьте заголовки страниц, описания и запись в карту сайта для каждой записи. Наш гид по SEO для сайтов, созданных с ИИ охватывает основы.
6. Админ-страница и вход, если выбрали вариант с базой данных.
7. Значок «Что нового» в вашем приложении.
8. Напишите настоящие записи за последние несколько месяцев, чтобы страница не запускалась пустой.

Частые ошибки

• Копирование сообщений коммитов. Пишите для пользователей, а не для разработчиков.
• Одна огромная страница без URL для каждой записи. Никто не может сослаться на конкретное изменение, а поисковики видят одну страницу вместо многих.
• Обновления прекращаются через месяц. Чейнджлог, который не обновлялся год, наводит на мысль о заброшенном продукте. Выберите ритм, который сможете выдерживать.
• Загрузка записей только в браузере. Поисковики и превью ссылок могут увидеть пустую страницу. Отрисовывайте заранее или на сервере.
• Смешивание с инцидентами. Сбои относятся к странице статуса, а не к чейнджлогу.

Когда лучше готовый сервис для чейнджлога

Существуют готовые сервисы для чейнджлогов и обновлений продукта; некоторые идут в комплекте с досками обратной связи или виджетами внутри приложения. Они стоят того, если нужны всплывающие окна в приложении, таргетинг по аудиториям и аналитика без собственной разработки или если ваша команда уже платит за инструмент, в который это входит. Программное обеспечение для блога или справочного центра тоже может иметь подходящий формат.

Собственный чейнджлог имеет смысл, когда вы хотите, чтобы он жил на вашем домене, в вашем дизайне и полностью индексировался; для простого списка датированных записей работы немного.

Как сделать чейнджлог в Mythex

В Mythex вы можете попросить агента добавить чейнджлог в существующий проект или собрать его как отдельный небольшой сайт и увидеть, как он строится, в живом предпросмотре. Версия на файлах не требует базы данных. Если вы выбираете версию с админкой, агент добавляет выделенную базу Postgres, когда записи нужно сохранять (или введите /database), а скриншоты хранятся в файловом хранилище проекта. Вход в админку вы добавляете со своим подходом к аутентификации (рецепт добавления входа).

Новые приложения Mythex часто являются одностраничными приложениями, которые отрисовываются в клиенте, а рецепт по SEO отмечает, что для поиска они слабее; если хотите, чтобы записи находились в поиске, попросите статические или заранее отрисованные страницы чейнджлога. Тот же рецепт описывает заголовки, описания и карты сайта. Для старта со встроенным чейнджлогом посмотрите шаблон база знаний продукта.

Вопросы