Changelog to lista nowości, ulepszeń i poprawek produktu, pokazywana klientom jako osobny widget - ikona w rogu strony, a po kliknięciu lista wpisów z datami. Zasilają go wpisy z bazy wiedzy, więc nie prowadzi się go osobno.
Gdzie to znajdziesz
Skąd biorą się wpisy
Dwiema drogami:
- z wpisu bazy wiedzy - na formatce wpisu zaznacz Do changelog. Wpis trafia na listę changelogu i jest z nim dalej związany: poprawisz wpis, poprawi się też wpis changelogu,
- ręcznie - przycisk Dodaj na liście changelogu. Podajesz tytuł, treść i bazę wiedzy, a pole Wpis (opcjonalnie) zostawiasz puste. Tak dodaje się krótkie notki, które nie zasługują na osobny artykuł.
Changelog należy do konkretnej bazy wiedzy - każda baza ma własną listę.
Osadzenie na stronie
Kod widgetu jest na karcie bazy wiedzy, w sekcji poświęconej changelogowi: skopiuj go i wklej na swojej stronie w miejscu, w którym widget ma się pojawić. Przycisk Testuj changelog pokazuje, jak to będzie wyglądać - widget wchodzi jako ikona, a lista otwiera się po kliknięciu.
Widget czyta treść z pliku generowanego przy każdej zmianie, więc na stronie klienta nie ma żadnego zapytania do Twojego panelu.
Co warto robić
- pisz z perspektywy klienta - „Faktury można teraz wysyłać zbiorczo”, nie „refaktor modułu faktur”,
- krótko - changelog czyta się w kilkanaście sekund; szczegóły zostaw wpisowi w bazie, do którego widget i tak linkuje,
- regularnie - pusta lista przez trzy miesiące wygląda gorzej niż brak widgetu.
Publiczna strona changelogu
Poza widgetem changelog ma własną stronę w bazie wiedzy - z podtytułem „Śledź nowości, ulepszenia i poprawki produktu” i przyciskiem powrotu do bazy. To dobry adres do wysłania w mailu po wydaniu nowej wersji.
Strona pojawia się sama, gdy baza ma choć jeden wpis changelogu - wtedy na stronie głównej bazy jest przycisk Changelog, a w szablonie docs także link Changelog w górnym menu (i w menu na telefonie), widoczny na każdej stronie bazy. Bez wpisów nie ma ani strony, ani linków.