To faux pas nauczyło mnie, że muszę patrzeć na nasz produkt przez pryzmat klienta. Wtedy przysłowiowy włącznik światła kliknął "on". Jeśli dostarczę produkt, który odpowiada na bolączki klienta, a następnie wesprę go profesjonalną dokumentacją produktu, będziemy mieli zwycięzcę.
Odkryłem również, że tworzenie profesjonalnej, estetycznej i łatwej do odczytania dokumentacji produktu nie jest łatwym zadaniem. Ale prawidłowo wykonana dokumentacja produktu może sprawić, że zadowoleni klienci będą zachwyceni i ostatecznie zwiększą przychody.
Jakie są najlepsze praktyki tworzenia profesjonalnej dokumentacji produktu?
Te najlepsze praktyki tworzą estetyczną, informacyjną i łatwą w użyciu dokumentację produktu. Przestrzeganie tych wytycznych pomoże dostarczyć dokumentację produktu, która może sprawić, że dobry klient stanie się świetnym klientem. A świetni klienci ostatecznie pomagają firmom zwiększyć przychody, a dokumentacja produktu jest istotnym elementem doświadczenia klienta.
1. Zrozum swoich docelowych odbiorców i daj im to, czego chcą
Niezbędne jest poznanie oczekiwań odbiorców. Na przykład, czy dokumentacja produktu jest przeznaczona dla administratorów czy użytkowników końcowych? Zakres docelowych odbiorców może wymagać pisania technicznie dla administratorów lub w jasno określonych terminach i instrukcjach dla użytkownika końcowego.
Najlepszą praktyką tworzenia profesjonalnej dokumentacji produktu jest zrozumienie oczekiwań klienta na poziomie administratora lub użytkownika końcowego. Niektóre z metod zbierania informacji identyfikujących odbiorców to:
-
Kwestionariusze i ankiety
-
Opinie postrzeganych odbiorców
-
Firmowa burza mózgów
-
Informacje zwrotne na temat popularnych opinii klientów
-
Dyskusje okrągłego stołu z klientami
2. Stworzenie planu dokumentacji jako najlepszej praktyki
Napisanie planu dokumentacji może pomóc dostrzec wszelkie potencjalne wąskie gardła podczas wdrażania projektu. Tworzenie dokumentacji produktu może być wyzwaniem, a najlepszą praktyką jest stworzenie planu dokumentacji, aby pomóc przewidzieć problemy, które mogą pojawić się podczas procesu dokumentacji.
Wśród korzyści płynących z tworzenia planu dokumentacji można wymienić następujące:
-
Audyt istniejącej dokumentacji w celu odzyskania istotnych informacji, które można ponownie wykorzystać w nowym planie dokumentacji produktu.
-
Przestrzeganie szablonów i przewodników stylu - jeśli dokumentacja produktu dotyczy nowego produktu, należy upewnić się, że pozostaje ona w zgodzie z głosem i stylem branży, a jeśli dokumentacja dotyczy istniejącego produktu, należy zachować aktualne przewodniki stylu i szablony, aby zapewnić ciągłość marki**.
Oprzyrządowanie procesu dokumentacji - Oprzyrządowanie dokumentu może zdefiniować i usprawnić proces dokumentacji produktu, zapewniając jednocześnie ciągłość pracy zespołowej i lepsze zrozumienie procesu opracowywania dokumentów.
3. Uproszczenie dokumentacji produktu jako najlepsza praktyka
W 2016 roku przeprowadzono badanie mające na celu ustalenie, ilu użytkowników czyta dokumentację produktu. Wyniki były zaskakujące, ponieważ odkryto, że tylko [25% użytkowników nie czyta dokumentacji produktu].(https://academic.oup.com/iwc/article-abstract/28/1/27/2363584?redirectedFrom=fulltext&login=false) Badanie wykazało, że brak czytania dokumentacji produktu przez użytkowników końcowych jest częściowo spowodowany następującymi czynnikami:
Użytkownicy są niecierpliwi - Wraz z pojawieniem się natychmiastowych informacji za pośrednictwem Internetu, użytkownicy zazwyczaj stają się mniej cierpliwi w odkrywaniu odpowiedzi na swoje problemy. Czytanie dokumentacji produktu online lub offline może być pracochłonne ze względu na dużą ilość informacji wymaganych dla danego produktu.
-
Syndrom pomijania** - użytkownicy często pomijają niezbędną dokumentację produktu, przechodząc od razu do podstaw jego użytkowania. Użytkownicy uczą się i rozumieją, jak działają produkty poprzez interakcję z produktem, a nie czytanie szczegółowych instrukcji. Instrukcje muszą być tak jasne i bogate w informacje, jak to tylko możliwe.
-
Zagmatwany układ i struktura - instrukcje są często pisane w formacie, który jest trudny do zrozumienia i przestrzegania. Wielu użytkowników uważa, że dokumentacja produktu jest zagmatwana lub nieistotna dla ich pytania, stając się sfrustrowanym i zniechęconym do czytania instrukcji. Często zdarza się, że firma nie przeprowadziła szczegółowego badania odbiorców i nie zrozumiała prawidłowo, czego potrzebuje użytkownik, który stał się zbyt zdezorientowany, aby dokończyć czytanie.
4. Dołączanie zrzutów ekranu i informacji graficznych
Pomyśl o dokumentacji produktu jak o mapie drogowej opowiadającej historię o produkcie. Poprowadź klienta ścieżką, którą można łatwo zidentyfikować za pomocą zrzutów ekranu lub innych grafik (https://theideanest.ca/5-types-graphics/?doing_wp_cron=1666462401.5462460517883300781250) i wyjaśnij, w jaki sposób każda grafika współdziała z innymi. Wyjaśnij jasno, na co patrzy użytkownik lub kiedy funkcja jest aktywowana, jak reaguje na produkt i czego może się spodziewać dalej. Upewnij się, że każda grafika jest celowa i że przepływ pracy produktu współpracuje ze sobą.
5. Używaj odnośników dla dokładniejszego zrozumienia tematów.
Przekonałem się, że linki krzyżowe są nieocenione podczas czytania dokumentacji produktu. Zrozumienie tego, co robi dana funkcja lub proces, bardzo pomaga w powiązaniu z powiązanym tematem. Ponadto, dzięki powiązaniu powiązanych punktów danych, ogólny obraz staje się bardziej widoczny w odniesieniu do interakcji systemu i przepływu pracy.
6. Pamiętaj o zasadzie KISS dla dokumentacji produktu.
Pamiętaj, aby podczas tworzenia dokumentacji stosować zasadę KISS (Keep It Simple, Stupid). Ważne jest jednak, aby dokładnie udokumentować proces, ale nie przesadzać z dokumentacją. Ponadto użytkownik dokumentacji może poszukiwać określonych informacji na temat konkretnych elementów, więc przestrzeganie zasady KISS pozwala na znacznie łatwiejszą nawigację i zrozumienie dokumentacji.
Na przykład, proste notacje mogą wystarczyć do wyjaśnienia funkcji, być może z odniesieniem (odsyłaczem) do głównego tematu. Utrzymuj fakty w czystości i nie przesadzaj, aby użytkownik mógł łatwo wyszukiwać informacje istotne dla jego potrzeb. Użytkownik może nie być zainteresowany zapoznaniem się z każdym aspektem produktu.
7. Dostosowanie do różnych stylów uczenia się
Każda osoba ma inny styl uczenia się. Niektórzy wolą dogłębne opisy, podczas gdy inni mogą preferować grafikę i reprezentacje wizualne. Jednak niektórzy użytkownicy uczą się bardziej poprzez praktyczne zaangażowanie niż czytanie.
Upewnij się, że uwzględniasz wszystkie style uczenia się podczas tworzenia skutecznej i pouczającej dokumentacji produktu. Na przykład wstawianie grafik, takich jak zrzuty ekranu, wykresy, tekst strukturalny lub linki wideo, pomaga zapewnić, że wszystkie style uczenia się rozumieją dokumentację produktu.
8. Personalizuj i strukturyzuj treści onboardingowe
Spersonalizuj produkt dokumentację w oparciu o rolę odbiorców. Twórz różne wersje dokumentacji w oparciu o role docelowych odbiorców podczas wdrażania treści. Na przykład pytania administratora mogą nie być istotne dla pytań użytkownika zaawansowanego dotyczących dokumentacji.
Dokumentacja może wprowadzić warstwę personalizacji, tworząc nieco inne wersje dokumentu ukierunkowane bardziej na rolę docelowych odbiorców. Modyfikowanie treści onboardingu w oparciu o rolę odbiorców nadaje dokumentacji element personalizacji.
9. Wyraźnie zdefiniuj terminy dla określonych odbiorców
W zależności od docelowych odbiorców, dobrą praktyką jest wyjaśnienie znaczenia każdego terminu używanego w dokumentacji. Możesz używać bardziej złożonych terminów z pewnym wyjaśnieniem, jeśli odbiorcy są wewnętrzni. Jednak gdy użytkownicy zewnętrzni uzyskują dostęp do dokumentacji, nie ma możliwości poznania ich wiedzy specjalistycznej.
Jasne zdefiniowanie unikalnych lub złożonych terminów zapewnia znacznie lepszą i bardziej wydajną komunikację dla wszystkich wewnętrznych interesariuszy i użytkowników zewnętrznych.
10. Zapewnienie metody zbierania opinii użytkowników
Opinie na temat dokumentacji dostarczają ważnych informacji na temat skuteczności dokumentu. Zapewnij link lub prosty przycisk "Lubię to/nie lubię tego", aby zebrać cenne informacje na temat jakości dokumentacji. Dzięki zbieraniu opinii użytkowników dokumentacja może być udoskonalana i ulepszana.
11 Unikaj dokumentacji o płaskiej strukturze
Podczas tworzenia dokumentacji produktu upewnij się, że dokumentacja nie jest napisana jako "płaska struktura". Czytanie dokumentu pełnego płaskiego tekstu jest pracochłonne i może stać się nużące. Ponadto zainteresowanie czytelnika dokumentacją będzie większe, jeśli informacje są istotne dla omawianego tematu, a czytelnik może je szybko skonsumować.
Rozbij ciągły, płaski tekst, podświetlając wybrane informacje lub integrując filmy, obrazy, linki i inne metody, aby zapewnić lepszy UX. Ponadto, dostarczając treść dokumentu w kawałkach "wielkości kęsa", czytelnik będzie miał przyjemniejsze wrażenia i będzie mniej niechętny do czytania dokumentacji.
12. Tworzenie dokumentacji przyjaznej dla SEO
Najlepszą praktyką dotyczącą dokumentacji produktu online jest upewnienie się, że jest ona napisana w stylu przyjaznym dla SEO dokumentacji. Zapewnienie, że dokumentacja jest napisana tak, aby zmaksymalizować wyniki wyszukiwania w Internecie dla dokumentacji. Klienci mogą potrzebować wyszukać swoją dokumentację, a gdy nie mają wyraźnego linku do witryny hostingowej, wprowadzając wyszukiwane hasła, odpowiedzi są szybsze i bardziej zwięzłe, gdy są przyjazne dla SEO.
13. Aktualizuj dokumentację produktu
Utrzymanie dokumentacji produktu ma kluczowe znaczenie, przede wszystkim w przypadku dostępu online. Często wymagania dotyczące produktu zmieniają się, a dokumentacja online musi odzwierciedlać wszelkie nowe zmiany lub aktualizacje. Dlatego dokumentacja użytkownika musi być aktualna i odświeżona o wszelkie ostatnie aktualizacje oraz zapewniać, że klient jest powiadamiany i świadomy zmian w dokumentacji produktu.
14. Zrozumienie, że użytkownicy mogą nie czytać dokumentacji produktu
Badanie z 2014 roku wykazało, że użytkownicy nie przeczytali w całości](https://academic.oup.com/iwc/article-abstract/28/1/27/2363584?redirectedFrom=fulltext&login=false) całej dokumentacji produktu. Głównymi powodami nieczytania dokumentacji były:
-
Dokumentacja produktu była zbyt złożona
-
Dokumentacja nie odpowiadała bezpośrednio na ich pytania
-
Użytkownicy nie korzystali z wielu funkcji produktu, ponieważ nie czytali dokumentacji.
-
Zamiast czytać dokumentację, wielu użytkowników wolało "praktyczną" naukę
15. Zarządzanie zarówno dynamiczną, jak i statyczną treścią
Dokumentacja produktu nieustannie ewoluuje wraz z aktualizacjami, nowymi funkcjami, poprawioną zawartością, zaktualizowanymi alertami konserwacyjnymi i innymi elementami. Ta aktualizacja jest uważana za żywy, oddychający dokument, który nieustannie ewoluuje zgodnie z wymaganiami produktu.
Zawartość statyczna zapewnia użytkownikowi dane, które nie zmieniają się przez cały okres życia produktu. Ideą treści statycznych jest zapewnienie użytkownikom, zwłaszcza nowym użytkownikom, informacji, które pozostają statyczne przez cały cykl życia produktu. Zawartość statyczna jest niezbędna dla bogatej dokumentacji, ale zazwyczaj zajmuje tylne miejsce w stosunku do dokumentacji dynamicznej.
Utrzymanie zestawu dokumentacji jest łatwiejsze, gdy zawartość jest sklasyfikowana jako dynamiczna lub statyczna. Dokumentację cyklu życia produktu można wdrożyć i zweryfikować łatwiej, gdy dokumentacja jest sklasyfikowana jako dynamiczna lub statyczna. W dokumentacji mogą wystąpić niewielkie zmiany dotyczące aktualizacji nowych funkcji (statyczne) lub szczegółowych aktualizacji produktu (dynamiczne).
16. Najlepsze praktyki w zakresie dostępności dokumentacji produktu
Chociaż użytkownicy niekoniecznie czytają dużo dokumentacji produktu, kiedy jej potrzebują, chcą ją mieć natychmiast. Tradycyjną metodą dostarczania dokumentacji była drukowana instrukcja, która była dostarczana wraz z produktem. Jednak w dzisiejszym cyfrowym świecie online dokumentacja jest często dostarczana za pośrednictwem Internetu.
Niezależnie od tego, w jaki sposób dostarczana jest dokumentacja produktu, niezbędne jest posiadanie łatwo dostępnych punktów dostępu. Dlatego też obecnie dominującymi metodami dostarczania dokumentacji są:
-
Dokumentacja offline - Wiele produktów jest dostarczanych z drukowanymi podręcznikami lub arkuszami skrótów "Szybki start". Dokumenty te są zazwyczaj "jednorazowe" i nie są łatwo dystrybuowane. Jednak wiele podręczników jest opcjonalnie dostarczanych w zamkniętym formacie PDF, promując przenośność lub opcję drukowania na żądanie.
-
Dokumentacja online**- Za każdym razem, gdy szukasz w Google odpowiedzi na jakiś problem, prawdopodobnie pobierasz fragment dokumentacji online. Pojawienie się Internetu wyparło drukowanie podręczników lub materiałów dokumentacji produktu dla użytkowników końcowych. Niektóre z zalet dokumentacji online to:
-
Telepraca - pandemia nauczyła nas, że praca w domu może być równie produktywna jak w biurze, zwłaszcza gdy na nasze pytania można znaleźć odpowiedź w dokumentacji online.
-
Współpraca - dzięki łatwo dostępnemu portalowi dokumentacji online członkowie zespołu mogą na bieżąco dzielić się informacjami i tworzyć pracę zespołową, co często jest niemożliwe w biurze.
-
Przyjazny dla urządzeń mobilnych - Pojawienie się urządzeń mobilnych, takich jak iPady i smartfony, powoli wypiera komputery PC w codziennych interakcjach. Możesz łatwo uzyskać dostęp do dokumentacji online za pomocą smartfona, a wszelkie dokuczliwe kwestie związane z produktem można łatwo zbadać, nawet w ulubionej kawiarni podczas lunchu.