Как да създадете страница с промени: записи, етикети, RSS и "Какво е новото"
Страницата с промени е датиран списък с това, което се е променило в продукта ви, най-новото първо, написан за хората, които го използват. За да създадете такава, са ви нужни записи с дата, ясно заглавие, кратко обяснение и етикет (Ново, Подобрено, Поправено), страница, която ги изброява, отделен URL адрес за всеки запис и, за предпочитане, RSS емисия и начин да кажете на потребителите, че има нещо ново. Това е едно от най-простите неща, които можете да изградите, а основното решение е къде живеят записите: като файлове в сайта ви или в база данни с административна страница.
Защо си струва да имате страница с промени
Страницата с промени показва на клиентите и потенциалните клиенти, че продуктът се поддържа. Дава на поддръжката и продажбите връзка за изпращане, когато някой попита "умее ли вече да прави X?". Тя е и място да затворите цикъла при обратната връзка: когато поискана функция излезе, записът в промените е това, към което насочвате хората. Ако управлявате портал за обратна връзка от клиенти, свързвайте изпълнените заявки директно с техните записи.
Страницата с промени не е вашата вътрешна история на комитите. "Рефакторирана услуга за фактуриране" не означава нищо за потребителя. "Фактурите вече показват ДДС номера на вашата компания" означава.
От какво има нужда страницата
Съдържание за всеки запис
| Поле | Бележки |
|---|---|
| Заглавие | Какво се е променило, от гледна точка на потребителя |
| Дата | Дата на публикуване, показана на страницата |
| Етикет | Ново, Подобрено, Поправено (и може би Премахнато или Сигурност) |
| Текст | Няколко изречения или точки; как се използва, кой го получава |
| Снимка или видео | По избор; една снимка помага повече от параграф |
| Slug | URL адресът на записа, например /changelog/invoice-vat-numbers |
| Статус | Чернова или публикуван, плюс дата за насрочено публикуване, ако е нужна |
Страници
- Индекс на промените: най-новите първи, с филтри по етикет и просто странициране или "зареди още".
- Страница на запис: един запис на URL адрес, така че да може да се свързва и споделя.
- RSS или Atom емисия: позволява на хората и инструментите да следят обновленията без имейл.
- Административна страница (само във версията с база данни): писане, преглед, насрочване и публикуване на записи.
Допълнения в приложението
- Значка "Какво е новото": точка до пункт от менюто, когато има записи, които потребителят не е видял. Запазвайте датата на последния запис, който е отворил, за всеки потребител или в браузъра.
- Имейл обобщение: резюме, изпращано на потребителите, които са се съгласили. За това е нужен доставчик за изпращане; вижте как да изпращате имейли от приложението си.
Основното решение: файлове или база данни
Записи като файлове в сайта
Всеки запис е Markdown файл в проекта. Публикуването на запис означава добавяне на файл и ново внедряване. Това е най-простият и най-устойчив подход: без база данни, без административен вход, нищо за защита, а страниците могат да се генерират предварително, така че се зареждат бързо и са лесни за четене от търсачките.
Подхожда на екипи, в които хората, които пишат записите, се чувстват удобно да питат AI конструктора или да редактират файл.
Записи в база данни с административна страница
Записите живеят в таблица, а частна административна страница позволява на всеки от екипа да пише, преглежда, насрочва и публикува. Това подхожда на екипи, в които маркетингът или поддръжката пишат обновления, или когато искате насрочено публикуване или записи за различна аудитория (например да показвате функции за корпоративни клиенти само на корпоративни клиенти).
Цената е повече работа за изграждане и поддръжка: административен вход, качване на снимки и гарантиране, че публичните страници все още се четат от търсачките, което страница, която зарежда записите само в браузъра, може да не позволи.
| Файлове | База данни + администрация | |
|---|---|---|
| Кой може да публикува | Който редактира проекта | Всеки с административен вход |
| Настройка | Минимална | Вход, хранилище, административен интерфейс |
| SEO | Лесно (предварително генерирани страници) | Изисква внимание, за да се генерират страниците на сървъра или предварително |
| Насрочване | Публикуване при внедряване | Може да се насрочва по дата |
| Цена на хостинга | Статичен | Изисква работещо приложение и база данни |
Писане на записи, които хората четат
- Започнете с ползата. "Експорт на отчети в Excel" е по-добре от "Нов модул за експорт".
- Кажете кой го получава. Всички планове, само Pro, постепенно внедряване тази седмица.
- Покажете го. Една снимка или кратък клип.
- Групирайте малките поправки. Седмичен запис "Поправки и подобрения" с точки не позволява на страницата да се наводни.
- Бъдете честни при премахванията. Ако нещо отпада, кажете кога и какво да се използва вместо него.
Първи промпт, който работи
Добави публична страница с промени на сайта ни на /changelog. Всеки запис е Markdown файл със заглавие, дата, етикет (Ново, Подобрено или Поправено), по избор корична снимка и текст. Индексната страница показва записите, най-новите първи, с датата, етикета и първия параграф, има бутони за филтриране по етикет и показва 10 записа на страница. Всеки запис има собствена страница на адрес /changelog/<slug> с подходящо заглавие и описание за търсачките. Добави RSS емисия на адрес /changelog/rss.xml. Създай три примерни записа. Съобрази се с дизайна на сайта, запази четимостта на телефони и генерирай предварително страниците, за да се зареждат бързо.
За версията с база данни замени първото изречение с: "Съхранявай записите в база данни със статус чернова/публикуван и дата на публикуване, и добави защитена с парола административна страница за писане, преглед и публикуване."
Стъпки за изграждане
- Решете файлове или база данни, според таблицата по-горе.
- Изградете индексната и страниците на записите с няколко примерни записа.
- Добавете етикети и филтри.
- Добавете RSS емисията и я свържете от страницата.
- Добавете заглавия на страниците, описания и запис в sitemap за всеки запис. Нашето ръководство за SEO за уебсайтове, създадени с AI обхваща основите.
- Административна страница и вход, ако сте избрали пътя с база данни.
- Значка "Какво е новото" във вашето приложение.
- Напишете истински записи за последните няколко месеца, за да не стартира страницата празна.
Чести грешки
- Копиране на съобщенията от комитите. Пишете за потребителите, не за разработчиците.
- Една огромна страница без URL адреси за отделните записи. Никой не може да свърже конкретна промяна, а търсачките виждат една страница вместо много.
- Обновленията спират след месец. Страница с промени, обновявана за последно преди година, подсказва изоставен продукт. Задайте ритъм, който можете да поддържате.
- Зареждане на записите само в браузъра. Търсачките и визуализациите на връзки може да видят празна страница. Генерирайте предварително или на сървъра.
- Смесване с инциденти. Прекъсванията принадлежат на страница със статус, а не на страницата с промени.
Кога хостнат инструмент за промени е по-добрият избор
Съществуват хостнати инструменти за промени и обновления на продукти, а някои идват с табла за обратна връзка или джаджи в приложението. Те си струват, ако искате изскачащ прозорец в приложението, насочване към аудитории и анализи, без да ги изграждате, или ако екипът ви вече плаща за инструмент, който ги включва. Софтуерът ви за блог или център за помощ може също да има подходящ формат.
Създаването на собствена страница има смисъл, когато искате страницата с промени на собствения ви домейн, в собствен дизайн и напълно индексируема, а за прост списък с датирани публикации това не е много работа.
Изграждане с Mythex
В Mythex можете да помолите агента да добави страница с промени към съществуващ проект или да я изгради като отделен малък сайт и да я видите в live прегледа, докато се изгражда. Версията с файлове не изисква база данни. Ако изберете версията с администрация, агентът добавя собствена Postgres база данни, когато записите трябва да се запазват (или напишете /database), а снимките отиват в файловото хранилище на проекта. Входът за администраторите е нещо, което добавяте с вашия собствен подход за удостоверяване (рецепта за добавяне на вход).
Новите приложения в Mythex често са едностранични приложения, генерирани в браузъра, а рецептата за SEO отбелязва, че те са по-слаби за търсене, затова поискайте статични или предварително генерирани страници за промените, ако искате записите да се намират в търсене. Същата рецепта покрива заглавията, описанията и sitemap. За начална точка с вградена страница с промени вижте шаблона център за знания за продукта.
Въпроси
Какво трябва да съдържа един запис в промените?
Дата, кратко заглавие, което казва какво се е променило за потребителя, няколко изречения или точки, които го обясняват, етикет като Ново, Подобрено или Поправено, и по избор снимка и връзка към повече подробности.
Нужна ли е база данни за страница с промени?
Не непременно. Ако един-два човека публикуват обновления, записите могат да живеят като Markdown файлове в сайта и да се публикуват с всяко внедряване. Използвайте база данни, когато хора без технически опит трябва да пишат и да насрочват записи от административна страница.
Колко често трябва да обновявам страницата с промени?
Винаги, когато нещо, което потребителите биха забелязали, се промени. Много малки продукти групират промените седмично или на всеки две седмици; важното е стабилен ритъм, за да изглежда страницата жива.
Добра ли е страницата с промени за SEO?
Може да помогне малко: всеки запис е страница за функция, която търсачките могат да индексират, а редовно обновявана страница показва активен продукт. Дайте на всеки запис собствен URL адрес и описателно заглавие.