Kompletny przewodnik po dokumentacji produktu: wszystko, co musisz wiedzieć, aby tworzyć świetne dokumenty

Dokumentacja produktu… może nie jest to najseksowniejsza część prowadzenia firmy, ale jest to kluczowy obszar, którego nie należy przeoczyć, jeśli chcesz, aby Twoja firma odniosła sukces.

Tworzenie wysokiej jakości dokumentacji produktu może pomóc zwiększyć sukces klientów, zmniejszyć obciążenie związane z obsługą techniczną i ogólnie zbudować lepszą firmę.

Ale na czym polega tworzenie dokumentacji produktu? A jak założyć własną dokumentację na swojej stronie?

To tylko kilka pytań, na które odpowiemy w naszym ostatecznym przewodniku po dokumentacji produktu. Oto wszystko, co omówimy:

• Dlaczego powinieneś dbać o swoją strategię dokumentacji produktów
• Kilka prawdziwych przykładów dokumentacji z najwyższej półki
• Najlepsze oprogramowanie do dokumentacji produktów
• Osiem wskazówek dotyczących tworzenia lepszej dokumentacji

Czy jesteś gotowy, aby poprawić sposób, w jaki Twoja firma radzi sobie z dokumentacją? Zagłębmy się!

Dlaczego powinieneś dbać o swoją strategię dotyczącą dokumentacji produktu

Zacznijmy od przyjrzenia się, dlaczego nie należy skąpić w strategii dokumentacji produktu.

Sprawia, że ​​Twoi klienci odnoszą większe sukcesy

Największą zaletą tworzenia dokumentacji produktu jest to, że zwiększa ona sukces Twoich klientów. Posiadanie bardziej udanych klientów oznacza wyższe współczynniki konwersji, niższe współczynniki rezygnacji i tak dalej.

Ma to sens – jeśli klient nie może dowiedzieć się, jak uzyskać wartość z twojego produktu, nie pozostanie nim na długo.

Dokumentacja produktu to jeden z przydatnych sposobów edukowania klientów, aby mogli uzyskać jak największą wartość. Gdy uzyskają większą wartość z Twojego produktu, będą bardziej skłonni dalej płacić, polecać Cię swoim znajomym/współpracownikom i tak dalej.

Zmniejsza obciążenie wsparcia

Dokumentacja produktu może być również świetnym sposobem na zmniejszenie obciążenia kanałów wsparcia ludzkiego.

Jeśli dokumentacja produktu jest niskiej jakości lub nie istnieje, oznacza to, że klienci muszą kontaktować się z zespołem pomocy technicznej za każdym razem, gdy pojawia się problem. Oznacza to więcej czasu spędzonego na odpowiadaniu na prośby o wsparcie.

Będziesz musiał poświęcić trochę czasu na rozwój firmy, aby samodzielnie obsłużyć te odpowiedzi, albo musisz zatrudnić oddaną osobę do pomocy ( co kosztuje ).

Dzięki wysokiej jakości dokumentacji klienci będą mogli rozwiązać wiele własnych problemów, co eliminuje potrzebę sięgania po wsparcie. Możesz także ustrukturyzować swoje procesy wsparcia, aby zachęcić ludzi do sprawdzenia Twojej dokumentacji przed złożeniem wniosku.

Może być dobrym narzędziem marketingowym i sprzedażowym

Podczas gdy wiele osób myśli o dokumentacji produktu w kontekście pomocy osobom, które już zdecydowały się na zakup, dobra dokumentacja produktu może przede wszystkim pomóc w przyciągnięciu i konwersji większej liczby klientów.

Z marketingowego punktu widzenia dokumentacja produktu jest kopalnią długich słów kluczowych SEO, według których możesz uszeregować swoją dokumentację. Możesz być zaskoczony liczbą osób, które trafiają bezpośrednio do Twojej dokumentacji produktu z Google. Jeśli dobrze zorganizujesz swoją dokumentację, będziesz mieć szansę na przekształcenie tych osób w klientów.

Twoja dokumentacja może być również przydatnym narzędziem sprzedaży dla osób, które zastanawiają się nad zakupem Twojego produktu. Dokumentacja produktu może odpowiedzieć na potencjalne pytania przedsprzedażowe, które mogą mieć, przekonać ich, że Twój produkt może zrobić to, czego potrzebują, i dać im pewność, że otrzymają pomoc, gdy jej potrzebują.

Na przykład Stripe jest znany z posiadania najlepszej dokumentacji produktu. Jeśli wejdziesz na Twittera, zobaczysz wiele osób polecających Stripe ze względu na jakość dokumentacji Stripe:

Sprawia, że ​​Twoi pracownicy są bardziej efektywni

Dokumentacja produktu jest przeznaczona nie tylko dla klientów, ale może być również ważnym źródłem informacji dla członków zespołu, aby dowiedzieć się o produkcie i w razie potrzeby uzyskać odniesienie. Dotyczy to zwłaszcza nowych pracowników, którzy mogą nie mieć szerokiej bazy wiedzy o Twoim produkcie.

Cztery świetne przykłady dokumentacji produktów z życia wzięte

Aby dać ci więcej inspiracji, spójrzmy na kilka przykładów dokumentacji produktów ze świata rzeczywistego od odnoszących sukcesy firm.

1. Pasek

Wspomnieliśmy wcześniej o Stripe jako o jednym z najlepszych przykładów dokumentacji jakości jako narzędziu marketingowym/sprzedażowym, więc wiesz, że dokumentacja Stripe musiała być numerem jeden na naszej liście.

2. Adyeń

Adyen to platforma płatności dla eCommerce, płatności mobilnych i w punktach sprzedaży. Podobnie jak Stripe, oznacza to, że programiści muszą zintegrować go z własnymi platformami, co wymaga doskonałej dokumentacji. Adyen nie zawodzi – sprawdź pełną dokumentację Adyen tutaj.

3. Twilio

Jeśli nie znasz Twilio, jest to narzędzie, które pomaga firmom budować komunikację na ich platformach za pośrednictwem wiadomości tekstowych, wiadomości e-mail, połączeń telefonicznych i nie tylko. Podobnie jak w przypadku Stripe i Adyen, oznacza to, że firmy będą musiały zintegrować Twilio z istniejącymi usługami, co wymaga najwyższej jakości dokumentacji. Możesz przeglądać dokumenty Twilio, aby zobaczyć świetny przykład.

4. luz

Slack to kolejne narzędzie, które posiada bardzo dobrze napisaną i użyteczną dokumentację. Możesz przeglądać pełną dokumentację Slacka tutaj.

Aby zobaczyć więcej przykładów, zapoznaj się z naszym pełnym postem na temat najlepszych przykładów dokumentacji użytkownika.

Najlepsze oprogramowanie do dokumentacji produktu

Teraz przyjrzyjmy się, jak możesz zacząć oferować lepszą dokumentację produktu w swojej witrynie.

Porozmawiamy o pisaniu dokumentacji w następnej sekcji. Jednak zanim będziesz mógł napisać swoją dokumentację, potrzebujesz miejsca do przechowywania tych artykułów i udostępniania ich użytkownikom.

Chociaż możesz po prostu dodać te artykuły bezpośrednio do swojej witryny, znacznie lepszym pomysłem jest użycie dedykowanego oprogramowania do dokumentacji produktu. Poza porządkowaniem treści i udostępnianiem ich odwiedzającym, dobre oprogramowanie do dokumentacji produktów będzie zawierać inne przydatne funkcje, takie jak…

• Funkcje wyszukiwania Ajax ułatwiające odwiedzającym przeglądanie dokumentacji.
• Analiza wyszukiwania, dzięki której możesz zobaczyć, jakich tematów szukają ludzie.
• Dane o przydatności, dzięki którym możesz śledzić, jak pomocny jest każdy artykuł, i ulepszać je w razie potrzeby.

Oto dwa najlepsze rozwiązania…

Heroiczna baza wiedzy (heroiczna KB)

Heroic Knowledge Base to wtyczka do bezpłatnego oprogramowania WordPress o otwartym kodzie źródłowym, która umożliwia łatwe tworzenie własnego, samodzielnie hostowanego centrum dokumentacji produktów.

Jeśli korzystasz już z WordPressa na swojej stronie internetowej, możesz dodać Heroic Knowledge Base do swojej witryny, aby stworzyć własne centrum dokumentacji. Lub, jeśli nie, możesz utworzyć dedykowaną instalację WordPress dla swojej dokumentacji. W tym drugim przypadku możesz również zainteresować się motywem dokumentacji KnowAll WordPress .

Heroic Knowledge Base pozwala dodawać całą dokumentację za pomocą edytora treści WordPress, co ułatwia dołączanie treści multimedialnych w razie potrzeby. Otrzymasz również dostęp do wbudowanego systemu wersjonowania treści WordPress, który pozwala łatwo śledzić zmiany i porównywać poprzednie wersje Twojej dokumentacji.

Heroic Knowledge Base dodaje również szereg przydatnych funkcji, w tym:

• Natychmiastowe wyszukiwanie Ajax.
• Analiza wyszukiwania.
• Oceny przydatności artykułu.
• Załączniki do artykułów.

Heroic Knowledge Base kosztuje tylko 129 dolarów.

Adobe RoboPomoc

Jeśli publikujesz swoją dokumentację tylko w Internecie, potrzebujesz rozwiązania takiego jak Heroic Knowledge Base. Jednak w przypadku większej liczby potrzeb związanych z dokumentacją na poziomie przedsiębiorstwa mogą wystąpić sytuacje, w których trzeba opublikować dokumentację na wielu platformach, w tym w Internecie, papierze fizycznym, aplikacjach mobilnych, plikach PDF i tak dalej.

W takim przypadku możesz preferować wieloplatformowe narzędzie do tworzenia dokumentacji, takie jak Adobe RoboHelp. Od 29,99 USD miesięcznie do indywidualnego użytku, jest droższy niż Heroic Knowledge Base. Jeśli jednak potrzebujesz tworzenia treści na wielu platformach, ta dodatkowa cena może być warta swojej ceny.

Jak zoptymalizować strukturę i zawartość dokumentacji produktu?

Teraz, gdy masz już oprogramowanie potrzebne do zarządzania dokumentacją, porozmawiajmy o tym, jak pisać wysokiej jakości artykuły. Oto osiem kluczowych wskazówek dotyczących strukturyzowania dokumentacji i pisania lepszych artykułów pomocy…

1. Zrozum swoją publiczność

Aby napisać świetną dokumentację produktu, musisz zrozumieć odbiorców, dla których piszesz (tj. swoich klientów).

To, dla kogo piszesz, będzie miało wpływ na to, jakie informacje umieścisz i jak wszystko ustrukturyzujesz. Na przykład, jeśli piszesz dla programistów, Twoja dokumentacja powinna radykalnie różnić się od pisania dla zwykłych użytkowników.

Nie chcesz zakładać, że Twoi odbiorcy są ekspertami i pomijać kluczowe szczegóły, ale możesz założyć, że masz podstawową wiedzę w zależności od tego, kim są.

2. Poznaj różne typy dokumentacji produktu

Istnieją różne typy dokumentacji produktów i każdy z nich wymaga innego podejścia. Niektóre z typowych typów to:

• Przeglądy — te artykuły zawierają przegląd tego, jak działa dany obszar produktu, na przykład przewodnik „Wprowadzenie”.
• Samouczki krok po kroku – te artykuły pokazują ludziom, jak wykonać określone zadanie.
• Referencje – te artykuły wyjaśniają konkretne koncepcje w Twoim produkcie.
• Rozwiązywanie problemów — te artykuły wyjaśniają, jak debugować/rozwiązywać typowe problemy, które mogą napotkać klienci.

Rodzaj dokumentacji, nad którą pracujesz, powinien mieć wpływ na sposób pisania i struktury dokumentacji, dlatego ważne jest, aby wiedzieć, jaki jest cel, zanim zaczniesz się zagłębiać.

3. Bądź konsekwentny w swoim stylu i konwencjach nazewnictwa

Aby ułatwić klientom korzystanie z dokumentacji produktu, ważne jest, aby zachować ten sam styl i konwencje nazewnictwa w całej dokumentacji. Ułatwi to klientom śledzenie Twojej dokumentacji i unikniesz potencjalnych nieporozumień.

Aby Ci w tym pomóc, przydatne może być opracowanie przewodnika po stylu dla podstawowego formatowania i terminologii.

4. Używaj prostego języka i zachowaj zwięzłość

Wszystko równe, krótki, prosty język jest zawsze lepszy niż sałatka ze słów. Twoim celem powinno być przekazanie wszystkich niezbędnych informacji w jak najmniejszej liczbie słów.

W miarę możliwości należy również unikać używania żargonu lub skomplikowanych terminów. Nie wszyscy Twoi klienci będą mieli tę samą bazę wiedzy, a niektórzy mogą nawet nie być rodzimymi użytkownikami języka Twojej dokumentacji, więc utrzymywanie rzeczy tak prostych, jak to tylko możliwe, gwarantuje, że każdy będzie mógł czerpać korzyści z Twojej dokumentacji.

5. Uporządkuj dokumentację w logicznych artykułach „rozmiaru wydania”

Aby ułatwić ludziom przeglądanie dokumentacji i znajdowanie artykułów dotyczących ich konkretnych problemów, musisz podzielić dokumentację na logiczne segmenty. Generalnie każdy artykuł powinien być skoncentrowany na rozwiązaniu jednego konkretnego problemu.

Oczywiście w tym głównym problemie może być wiele podproblemów, ale chodzi o to, że nie chcesz wrzucać dwóch całkowicie oddzielnych problemów do tego samego artykułu, ponieważ utrudni to ludziom wyszukiwanie tych tematów i mogą być zdezorientowani, gdy wylądują na artykule.

Twoi klienci nie będą czytać Twojej dokumentacji w sposób liniowy, tak jak czytają książkę. Zamiast tego będą skakać w oparciu o problem, który w tej chwili napotykają. Podział artykułów na logiczne segmenty pomaga w wyjaśnieniu tego zachowania.

6. Włącz elementy multimedialne

Chociaż tekst pisany powinien stanowić rdzeń dokumentacji produktu, nie powinien być jedyną rzeczą. Pomocne może być również umieszczenie treści graficznych i wideo tam, gdzie ma to sens.

Jeśli dołączysz zrzuty ekranu, możesz również dodać adnotacje do obrazów, aby wyjaśnić kluczowe szczegóły.

7. Użyj nagłówków i dodaj spis treści

W artykułach z dokumentacją poszczególnych produktów używaj nagłówków, aby podzielić artykuły na logiczne segmenty, zamiast pisać tylko jedną długą ścianę tekstu.

Aby ułatwić użytkownikom poruszanie się po artykule, możesz również dodać spis treści, który pozwoli czytelnikom szybko przejść do określonej sekcji.

Niektóre programy do dokumentacji produktu mogą pomóc w automatycznym dodawaniu spisu treści. Na przykład wtyczka Heroic Knowledge Base ma wbudowaną funkcję automatycznego generowania spisu treści na podstawie nagłówków każdego artykułu.

8. Zawsze ulepszaj i aktualizuj swoją dokumentację

Na koniec należy pamiętać, że tworzenie dokumentacji produktu nie jest jednorazowym wydarzeniem; to ciągły proces.

Na poziomie podstawowym Twój produkt prawdopodobnie ulegnie zmianom, dlatego ważne jest, aby zaktualizować dokumentację, aby uwzględnić te zmiany i wszelkie dodane nowe funkcje.

Ale poza tym, jeśli wybierzesz oprogramowanie do dokumentacji produktu, takie jak Heroic Knowledge Base, uzyskasz dostęp do analiz, które pomogą Ci zrozumieć, w jaki sposób ludzie korzystają z Twojej dokumentacji. Możesz użyć tych danych analitycznych do:

1. Śledź, czego szukają ludzie, co może oznaczać, że musisz stworzyć dokumentację dotyczącą tych tematów, jeśli jeszcze tego nie zrobiłeś.
2. Zobacz, które artykuły nie pomagają użytkownikom tak bardzo, jak chcesz, co może oznaczać, że musisz wprowadzić ulepszenia w tych artykułach, aby zwiększyć ich przydatność.

Już dziś zacznij tworzyć niesamowitą dokumentację produktu!

Tworzenie wysokiej jakości dokumentacji produktowej to inwestycja w długofalowy sukces Twojej firmy. To pomaga…

• Spraw, aby Twoi klienci odnosili większe sukcesy.
• Zmniejsz obciążenie zespołu wsparcia.
• Przede wszystkim przyciągaj i konwertuj więcej klientów.
• Poszerz wiedzę swoich pracowników o Twoim produkcie.

W tym poście udostępniliśmy kilka świetnych przykładów dokumentacji produktów od odnoszących sukcesy firm wraz z kilkoma wskazówkami, jak pisać i organizować dokumentację.

Jeśli jesteś gotowy do stworzenia własnego centrum dokumentacji produktu, możesz użyć wtyczki Heroic Knowledge Base, aby zbudować własne rozwiązanie oparte na WordPress. Kliknij, aby dowiedzieć się więcej o Heroicznej Bazie Wiedzy.