1. Stosuj nagłówki.
2. Korzystaj z list numerowanych, opisując kroki w poradniku.
3. Stosuj listy punktowane – chociażby przy wypisywaniu przykładów.
4. Wykorzystuj wyodrębnione notatki (np. w postaci tekstu w ramce z tytułem "Pamiętaj!") lub tooltipy (podpowiedzi wyświetlające się po najechaniu dotknięciu), aby początkujący użytkownicy mogli lepiej zgłębić temat. Sprawdź, jak możesz je wprowadzić na platformie, której użyjesz do tworzenia bazy wiedzy.
5. Unikaj wielokrotnie złożonych zdań. Pisz zwięźle.
6. Korzystaj ze zrzutów ekranu z naniesionymi strzałkami czy wyróżnionymi obszarami. Możesz też wykorzystać GIF-y. Do nagrań panelu swojej usługi użyj darmowego narzędzia ScreenToGif.
7. Linkuj do innych poradników i stron, które nawiązują do tematu.
8. Unikaj pisania w stronie biernej.
9. Używaj pogrubień, aby wyróżnić istotne elementy.
10. Nie przesadzaj z wyróżnieniami. Jeśli wszystkie fragmenty są ważne i wyróżnione to tak, jakby nie wyróżniało się nic.

Ale przecież nikt nie mówił, jak mam pisać

Spisz wytyczne do języka komunikacji. To bardzo ważne. Wyobraź sobie sytuację, w której masz już, dajmy na to, sto poradników. Chcesz je uspójnić. Kiedyś trzeba to zrobić. W końcu spójność to jedna z podstawowych zasad brandingu i dobrej komunikacji. Szybko jednak zauważasz, że:

• używane są różne określenia na te same procesy, przez co początkujący użytkownik się gubi;
• jedne wykorzystują angielskie techniczne zwroty, inne polskie, a całość stwarza wrażenie, jakby była skierowana do zupełnie różnych odbiorców;
• w jednych są zwroty do klienta „na ty”;
• w części wszystko jest pisane w pierwszej osobie liczby mnogiej np. teraz klikamy, następnie sprawdzamy;
• formatowanie tekstu w poradnikach drastycznie się różni.

I teraz powodzenia w przerabianiu wszystkich treści.

Stwórz dokument, z którym zapozna się każda osoba, tworząca artykuły do bazy wiedzy. Zamieść w nim przykłady i wytyczne do tego, jak wygląda dobry poradnik. Pamiętaj o profilu klientów. Czy to specjaliści, którym niestraszne są techniczne zwroty? Czy to może raczkujące w twojej branży osoby, dla których HTML to nazwa niszowego zespołu rockowego, a o Photoshopie wiedzą tyle, że rymuje się z szopem?

W spisywaniu wytycznych nieoceniona może okazać się pomoc działu PR czy Marketingu, aby konsekwentnie stosować ten sam ton wypowiedzi w materiałach marki.

Bo jak to w życiu – trzeba mieć cel

Dobry poradnik to taki, który da się łatwo wcielić w życie. Baza wiedzy, to nie blog, z którego użytkownik na przykład wychodzi inspiracją do działania (z całym szacunkiem dla blogów). To porcja wiedzy, dzięki której będzie można podjąć konkretne akcje.

Czytelnik zazwyczaj szuka poradnika z intencją rozwiązania problemu. Planuj nowe teksty tak, aby po ich przeczytaniu dało się wyjść z jasną myślą: OK, wiem, co mam teraz zrobić. A jeszcze lepiej, jeśli można odtworzyć coś krok po kroku. Jeśli treści są owszem, ciekawe i przydatne, ale nie do końca wiadomo, jakie działania podjąć, czy jak wykonać przykłady z poradnika – lepiej będzie wykorzystać je chociażby na firmowym blogu.

Pamiętaj, aby każdy tekst tworzony do bazy wiedzy przechodził przez ten filtr. Wyobraź sobie, że jesteś użytkownikiem, który niekoniecznie jest gazelą internetu, a raczej powolnym winniczkiem. Czy dasz radę napisać prosto konkretne instrukcje i porady, aby taka osoba również wcieliła je w życie? Pamiętaj: twoim celem jest, aby poradniki były praktyczne.

Spokojnie, przy wyborze oprogramowania nie ważą się losy świata!

Wybór oprogramowania często jest wtórny

O ile nie tworzysz masywnej dokumentacji, która wymaga zaawansowanych opcji (wiele tłumaczeń, wielokrotne aktualizacje, dokumentacja API, reuse, ustrukturyzowana treść w XML), oprogramowanie najczęściej będzie kwestią wtórną.

Wtedy ważniejsze jest mądre przygotowanie kategorii i samych poradników. Oferta aplikacji typu knowledge base software jest ogromna. Oczywiście znając już swoje potrzeby, warto się jej przyjrzeć. Często jednak może okazać się, że już WordPress lub Zendesk Knowledge po niewielkim liftingu w zupełności wystarczy. WordPress ma również ciekawą zaletę: można go łatwo wgrać w katalogu na serwerze. Skutkuje to adresem typu mojausluga.pl/help Nie pozwalają na to usługi typu SaaS, gdzie twoja witryna musi być na osobnej domenie czy subdomenie np. help.mojausluga.pl

Plus posiadania bazy wiedzy w katalogu jest prosty: pod kątem pozycjonowania działa ona na korzyść głównej domeny. Wspiera w ten sposób stronę twojej usługi unikatową treścią i linkowaniem wewnętrznym.

Google jasno podaje, że traktuje subdomeny i podkatalogi tak samo. Jest to prawdą – roboty Google tak samo muszą przejść przez wszystkie podstrony i indeksują je w taki sam sposób. Jednak w praktyce w wypromowanie subdomeny należy włożyć większy wysiłek. W szczególności młode serwisy nie powinny zbyt wcześnie rozdrabniać się na subdomeny. To osobny temat omawiany przez wielu pozycjonerów, dlatego jeśli w twojej firmie są pracownicy zajmujący się SEO – skonsultuj to najpierw z nimi.

Podsumowania słów parę

Na koniec spróbujmy wyciągnąć kilka najważniejszych myśli, aby z lotu ptaka spojrzeć na temat bazy wiedzy:

• Do utworzenia spisu przyszłych poradników wykorzystaj dane od działu obsługi klienta.
• Najpierw lista tematów – potem lista kategorii.
• Pamiętaj, że dobre poradniki projektujemy, nie piszemy.
• Spisz wytyczne do tworzenia artykułów pomocy.
• Stosuj zasady UX writingu.
• Weryfikuj, czy po przeczytaniu poradnika czytelnik będzie umiał podjąć konkretne działania.
• Skonsultuj się ze specjalistą SEO.
• Wybierz oprogramowanie, którego użyjesz do zaprojektowania bazy wiedzy - w wypadku niewielkiego poziomu skomplikowania i małej liczby artykułów (do stu) z reguły wystarczy Ci coś prostego.