Jedną z najlepszych praktyk podczas wprowadzania nowego produktu na rynek jest przygotowanie do jego wydania. W szczególności chcemy skupić się na napisaniu nowej dokumentacji produktu, aby wesprzeć jego uruchomienie. Bez niej potencjalni użytkownicy nie będą mieli odpowiednich informacji do wykorzystania jako punkt odniesienia po zakupie nowego rozwiązania.
W ramach szerszej strategii marketingowej menedżerowie produktu i członkowie zespołu produktowego powinni kontynuować czytanie, aby poznać 15 najlepszych praktyk, których należy przestrzegać podczas następnego uruchomienia. Pod koniec zrozumiesz, jak sprawić, by te ważne dokumenty były jak najlepsze!
Jakich rodzajów dokumentacji produktu powinienem być świadomy?
Zanim zagłębimy się w listę najlepszych praktyk, wyjaśnijmy, jakie rodzaje dokumentacji produktów istnieją i jaki jest zamierzony cel każdego z nich:
Dokumentacja wymagań produktu - dokument wymagań produktu lub PRD jest rodzajem wewnętrznej dokumentacji produktu używanej, aby pomóc firmom spełnić kryteria wydania. Wyjaśnia on, co produkt końcowy powinien osiągnąć dla użytkownika, bez szczegółowego określania sposobu i miejsca. Następnie zespoły programistów i testerów korzystają z PRD, aby dostosować produkt do wymagań biznesowych gotowych do wydania. PRD są powszechne w przypadku oprogramowania, ale można je wykorzystać do przestrzegania dowolnej mapy drogowej produktu.
Przewodniki użytkownika i samoobsługa - Zespoły produktowe będą musiały stworzyć przewodniki użytkownika jako miękki warunek wstępny udanego wprowadzenia produktu na rynek. Jak sama nazwa wskazuje, jest to dokumentacja, która ma pomóc użytkownikom końcowym zmaksymalizować ich produktywność podczas korzystania z nowego produktu. W tym przypadku wszystkie główne funkcje skierowane do użytkownika powinny zostać w pełni wyjaśnione, aby klienci mogli uzyskać jak największą wartość. Jeszcze lepszym rozwiązaniem jest udostępnienie tych przewodników w samoobsługowej zewnętrznej bazie wiedzy, aby klienci mogli sami sobie pomóc!
Przewodniki konfiguracji, instalacji i konfiguracji - jeśli produkt wymaga konfiguracji, instalacji i konfiguracji, jest to kolejny techniczny zasób dokumentacji produktu, który należy utworzyć. Celem jest jasne zilustrowanie tych procesów z perspektywy użytkownika i dewelopera, jeśli ma to zastosowanie. W przypadku dokumentacji oprogramowania może to dotyczyć wielu urządzeń i systemów operacyjnych, o czym należy pamiętać.
Aktywa marketingowe - Możesz nie myśleć, że jest to dokumentacja produktu, ale tak jest! Styl i format zasobów marketingowych wpływa na to, jak klienci postrzegają Twój produkt, zanim zaczną go używać. Zrobienie dobrego wrażenia jest kluczowe. Jak opisujesz nowe funkcje produktu? Dla jakich odbiorców jest on przeznaczony? W jaki sposób poprawi to czyjąś pracę lub życie osobiste? Czy to jest to, co ty i cała firma chcecie, aby klienci myśleli?
15 najlepszych praktyk dotyczących dokumentacji przy wypuszczaniu nowych produktów
Po tym elementarzu dotyczącym dokumentacji produktu, następna jest lista najlepszych praktyk:
1: Zacznij!
Dopiero zaczynasz pracę z dokumentacją produktu? Świetnie! Nie wahaj się zacząć. Wiele osób chce, aby dokumentacja produktu była PERFEKCYJNA; a dążąc do perfekcji, stają się sparaliżowani zadaniem. Zbierz podstawową koncepcję swoich usług na papierze, a następnie skup się na uporządkowaniu gotowych do zaimponowania klientom. Informacje o wydaniu są świetne do definiowania podstaw, a następnie można je rozbudować na podstawie tego dokumentu.
2: Keep it Simple, Stupid...
W skrócie KISS, jest to prawdziwa zasada projektowania, która pojawiła się (gra słów zamierzona) w amerykańskiej marynarce wojennej w latach 60-tych. Ta sama zasada może mieć zastosowanie do dokumentacji produktu. Zadaj sobie pytanie: "Jak przekazać niezbędne informacje w sposób zrozumiały dla wszystkich grup demograficznych?".
Aby zastosować to do wizji produktu, zalecamy test czytelności Flescha-Kincaida. Narzędzia do oceniania treści, takie jak Grammarly, często korzystają z tego systemu. Daje to wynik odpowiadający amerykańskiej ocenie w szkole średniej podczas analizy treści pisemnych. Celuj w klasę 8 lub wiek 13-14 lat jako wiek szkolny, aby zmaksymalizować interpretowalność treści - czekaj, mogliśmy powiedzieć... jak łatwo jest zrozumieć twoje pisanie.
3: Zrozum docelowych odbiorców
Więc zacząłeś i zachowałeś prostotę. Teraz musisz wiedzieć, dla kogo właściwie piszesz... Na przykład docelowi odbiorcy firm produkujących oprogramowanie będą bardzo różni od producentów samochodów.
Wyobraźmy sobie firmę zajmującą się oprogramowaniem edukacyjnym, która koncentruje się na prostych narzędziach pomagających młodym uczniom krok po kroku uczyć się pojęć. Pierwsza myśl, jaka może pojawić się w Twojej głowie, to "więc docelowymi odbiorcami są dzieci, prawda?". Niekoniecznie... Docelowymi odbiorcami są główne osoby podejmujące decyzje dotyczące pakietów oprogramowania w przedszkolu lub szkole średniej - takie jak dział IT i wewnętrzni interesariusze odpowiedzialni za zamówienia. Drugorzędnymi odbiorcami byliby młodzi uczniowie, którzy mogą zobaczyć oprogramowanie edukacyjne w środowisku naturalnym i opowiedzieć się za jego wykorzystaniem w swojej szkole.
4: Skup się na wartości, a nie na historii
Chociaż wszyscy uwielbiają dobre historie, klienci chcą wiedzieć, jaką wartość zaoferuje ich produkt. Czy uprości on zadanie lub przepływ pracy? Czy twój produkt jest dostępny offline, w przeciwieństwie do konkurentów, którzy są tylko online? Czy Twój produkt wykonuje daną czynność szybciej niż inne konkurencyjne produkty?
Te przykłady stanowią unikalne punkty sprzedaży (USP) dla konkretnej oferty. Skupienie się na USP i podkreślenie ich będzie kusić potencjalnych klientów i pomoże im zrozumieć, co masz, czego nie mają inni, aby zwiększyć udział w rynku. USP można zdefiniować, przeprowadzając analizę konkurencji w swojej branży.
5: Wykorzystaj formatowanie do kategoryzowania informacji
Dokumentacja nie powinna być dużym blokiem tekstu. Jest to trudne do przeskanowania i nawigacji dla użytkowników końcowych. Zamiast tego użyj nagłówków i innych opcji formatowania, aby podzielić tekst.
Nagłówki H1 są pierwszą rzeczą, którą ludzie widzą po kliknięciu na stronę. Nagłówki H2 i H3 pełnią rolę podtytułów dla tematów poruszanych na stronie. Możesz użyć punktorów lub list numerowanych, aby pogrupować treść w celu ułatwienia czytania, a nawet zakwalifikować się do Rich Snippets, aby poprawić SEO i widoczność w SERPS. Jeśli posiadasz wiedzę na temat Markdown, internetowy edytor Markdown, taki jak Docsie, oferuje wiele opcji formatowania, dzięki którym Twoje dokumenty produktowe będą się wyróżniać!
6: Przechowuj dokumentację w centralnej lokalizacji
Nie ma nic gorszego niż wydanie dokumentacji technicznej, a następnie uświadomienie sobie, jak skomplikowane będzie monitorowanie i zarządzanie nią w dłuższej perspektywie. Co jeśli dokumentacja wymaga aktualizacji? Gdzie jest oryginalny dokument i jak możemy wydać nowe wersje strony? A co z tłumaczeniem treści na inne języki?
W przypadku tej najlepszej praktyki musimy wspomnieć o Docsie! Oprogramowanie bazy wiedzy online umożliwia przechowywanie dokumentów w jednej scentralizowanej lokalizacji w chmurze. Z tego miejsca pracownicy i kontrahenci mogą współpracować nad treścią, aby przyspieszyć jej ukończenie przed uruchomieniem. Docsie oferuje zarządzanie kontrolą wersji, gdy trzeba zaktualizować wiedzę, oraz zarządzanie językami w celu globalnej lokalizacji treści. Jeśli chcesz zautomatyzować globalne tworzenie treści, mamy również sprytnego bota do tłumaczenia językowego AI, który dokładnie tłumaczy za Ciebie w tle!
7: Obraz przemawia tysiącem słów
Podczas gdy pisanie długich wyjaśnień, jak to zrobić, będzie działać, nie jest to skuteczny sposób nauczania użytkowników końcowych. Zamiast tego pokaż im zdjęcia, a nawet ruchome obrazy!
Spróbuj stworzyć towarzyszący samouczek wideo dla każdego dokumentu produktu. W ten sposób ci, którzy wolą czytać, mogą skanować tekst, podczas gdy osoby uczące się wzrokowo mogą wybrać wideo. Podobnie, GIF-y i obrazy mogą pomóc użytkownikom zobaczyć, do czego się odnosisz, zwłaszcza w interfejsie użytkownika oprogramowania. Dostosowanie się do różnych stylów uczenia się pomoże ci pomóc szerszemu gronu użytkowników, co oznacza większy potencjał dla twojego produktu.
8: Uczenie się vs. Cele vs. Zrozumienie vs. Informacje
Jaka jest intencja dokumentu? Intencja użytkownika ma kluczowe znaczenie w przypadku dokumentacji produktu online i pomaga dostosować zawartość do sekcji podróży użytkownika.
-
Uczenie się** - jeśli dana osoba nigdy wcześniej nie widziała danej rzeczy, treści edukacyjne pomogą jej zrozumieć podstawowe zasady.
-
Cele** - ten rodzaj treści powinien pomóc użytkownikom osiągnąć cel, taki jak "Jak wyeksportować plik PDF z Docsie". Pod koniec użytkownik osiągnie cel: wyeksportowanie pliku PDF.
-
Zrozumienie** - określane również jako badanie, jest przeznaczone dla klientów, którzy mają już praktyczną wiedzę na dany temat, ale chcą go lepiej zrozumieć.
Informacja - użytkownik ma pytanie i chce uzyskać konkretną odpowiedź. Może to być tak proste, jak pogoda w czasie rzeczywistym w określonej lokalizacji lub film o tym, jak zbudować domek na drzewie.
9: Możliwość wyszukiwania
Czy przed upublicznieniem dokumentacji użytkownicy mogą wyszukiwać słowa kluczowe w tekście?
Jeśli nie, zalecamy znalezienie platformy dokumentacji, która to obsługuje. Najważniejszym czynnikiem zniechęcającym użytkowników jest brak możliwości szybkiego znalezienia informacji. Prowadzi to do frustracji, dodatkowego obciążenia zespołu obsługi klienta, jeśli nie mogą znaleźć informacji, oraz negatywnego ogólnego doświadczenia klienta (CX). Aha, Docsie obsługuje globalne wyszukiwanie, jeśli się zastanawiasz!
10: Przygotowanie do zbierania przydatnych informacji zwrotnych
Autorzy dokumentacji będą świadomi faktu, że początkowa wersja treści z pewnością ulegnie zmianie. Dopóki opinia publiczna nie zobaczy dokumentacji, autorzy mogą jedynie odbijać pomysły i opinie od siebie nawzajem.
Po opublikowaniu dokumentacji uważamy, że niezbędne jest gromadzenie informacji zwrotnych. W ten sposób autorzy mogą przekształcić wszelkie negatywne treści w pozytywne, słuchając prawdziwych klientów i użytkowników końcowych. Nie musisz szukać gdzie indziej, możesz skorzystać z funkcji zbierania opinii w Docsie!
11: Link do strony, gdy wspominasz o temacie
Ta najlepsza praktyka opiera się na SEO i strukturach nawigacyjnych stron internetowych.
Kiedy wspominasz o słowie kluczowym, czy łączysz się z nim? Gdy odnosisz się do innych tematów, użytkownicy mogą jeszcze nie rozumieć innego tematu w kontekście bieżącej strony. Powinieneś linkować do wszystkich wspomnianych tematów, które mają dokumentację, ponieważ pozwala to czytelnikom szybko odwoływać się do podtematów podczas poznawania głównego tematu.
12: Jasność, nie dwuznaczność
Jasność przewyższa niejednoznaczność podczas pisania dokumentacji produktu. Aby uniknąć dwuznaczności, można używać prostego języka angielskiego, co zasadniczo oznacza unikanie żargonu i języka technicznego, chyba że jest to absolutnie konieczne. Jeśli używasz żargonu, pamiętaj, aby natychmiast po nim napisać uproszczoną definicję dla laików.
"Jeśli masz problemy ze zrozumieniem informacji zawartych w tej dokumentacji, poproś naszego przedstawiciela obsługi klienta o dodatkowe informacje na temat tego, jak przezwyciężyć trudności ze zrozumieniem".
"Jeśli wyświetlana treść jest trudna do zrozumienia, możesz poprosić obsługę klienta o pomoc".
Co wolisz?
13: Tworzenie szablonów w celu szybszego tworzenia dokumentów
Przy wprowadzaniu na rynek nowego produktu priorytetem jest przyspieszenie procesu tworzenia dokumentacji. Można to zrobić za pomocą szablonów.
Szablony definiują strukturę wielokrotnego użytku dla stron, pomagając pisarzom tworzyć treści szybciej i z większą spójnością. Można również tworzyć wiele szablonów dla różnych stylów treści. Docsie oferuje szereg gotowych szablonów do wykorzystania, wraz z obsługą szablonów niestandardowych.
14: Ustal ton głosu i przewodnik stylu dla pisarzy
Jak dużo swobody mają twoi pisarze?
Panowanie nad pisarzami jest ważne, ponieważ może to prowadzić do niespójności w końcowych wersjach dokumentacji produktu. Można to zrobić za pomocą wytycznych dotyczących tonu głosu (ToV) i przewodników po stylu pisania treści.
Ton głosu - Nie chodzi o to, co powiedziałeś... chodzi o sposób, w jaki to powiedziałeś. Czy chcesz, aby autorzy byli formalni i poprawni, czy bardziej swobodni? Czy humor jest dozwolony, czy tematy są poważniejsze? Czy Twoje treści mają być bardziej rozmowne i pełne pasji, czy chcesz tylko twardych faktów?
Wytyczne dotyczące stylu - ten dokument może wyjaśniać misję firmy i sposób, w jaki autorzy mogą przestrzegać ustalonego stylu podczas pisania i formatowania stron. W dokumencie tym mogą znaleźć się informacje na temat person użytkowników, zasady SEO, takie jak meta opisy, oraz wymagania dotyczące cytowania lub odwoływania się (Chicago, AP Style itp.).
15: Publikuj swoją dokumentację za pomocą potężnej platformy bazy wiedzy
Jeśli treść pisemna jest paliwem, to jakiego środka używasz, by dotrzeć z przekazem do odbiorców?
Potężna platforma bazy wiedzy jest niezbędna do wdrożenia wysokiej jakości dokumentacji produktu. Jeśli dokumenty staną się niedostępne lub strony będą się wolno ładować, cały wysiłek włożony w ich tworzenie pójdzie na marne.
Potrzebujesz możliwości importowania istniejących dokumentów, współpracy nad treścią z wewnętrznymi zespołami, tworzenia i edytowania nowych dokumentów, osadzania dynamicznych, bogatych treści i publikowania w witrynie wiedzy. Kontrola wersji ma również kluczowe znaczenie dla długoterminowych aktualizacji dokumentacji, wraz z zarządzaniem językami i automatycznym tłumaczeniem w celu globalnej lokalizacji treści.
Zgadłeś! Wszystkie te funkcje są dostępne w Docsie. Wypróbuj te funkcje, wypróbuj nasz darmowy plan Forever, aby rozpocząć!