Jak zbudować najlepszą dokumentację użytkownika

Możliwe, że jeśli Twoje produkty są bardziej złożone niż rolka ręczników papierowych, tworzysz pewnego rodzaju dokumentację użytkownika, aby pomóc ludziom nauczyć się z nich korzystać.

Dobrze wykonana, przyjazna dla użytkownika instrukcja obsługi produktu lub podręcznik użytkownika może oznaczać różnicę między fantastycznym doświadczeniem klienta a okropnym.

Ponadto dokumentacja użytkownika jest przeznaczona nie tylko dla nowych użytkowników.

Doświadczeni klienci mogą również odwołać się do instrukcji obsługi lub przewodników po produktach, aby odświeżyć swoje wspomnienia dotyczące funkcji, z której nie korzystali często, lub rozwiązać konkretny problem, który mają.

W tym poście skupimy się głównie na najlepszych praktykach tworzenia dokumentacji użytkownika dla produktów niefizycznych, takich jak oprogramowanie, ale większość (jeśli nie wszystkie) z tych wskazówek dotyczy również dziedziny sprzętu.

Oto, czego się dowiesz:

• Czym jest dokumentacja użytkownika i dlaczego jest ważna.
• Jak dokumentacja użytkownika końcowego jest częścią doświadczenia klienta.
• Jak dobra dokumentacja użytkownika może pomóc odciążyć zespół obsługi klienta.
• Dlaczego treści wizualne są sekretnym składnikiem najlepszej dokumentacji.
• Niezbędne elementy zapewniające najlepszą dokumentację użytkownika.
• Cztery kroki do stworzenia dokumentacji, która zachwyci Twoich klientów i przetrwa próbę czasu.

Czym jest dokumentacja użytkownika?

Dokumentacja użytkownika (nazywana również podręcznikami użytkownika końcowego, podręcznikami użytkownika końcowego, instrukcjami obsługi itp.) to zawartość, którą udostępniasz użytkownikom końcowym, aby pomóc im odnieść większy sukces w zakresie Twojego produktu lub usługi.

Są to materiały instruktażowe, które są dołączone do produktu, aby pomóc komuś nauczyć się go prawidłowo używać lub — w przypadku produktów fizycznych — nawet go złożyć.

Jeśli kiedykolwiek składałeś mebel IKEA, korzystałeś z dokumentacji użytkownika końcowego.

Jednak dokumentacja użytkownika przybiera wiele form.

Gry wideo są dostarczane z instrukcjami, które podpowiadają, które przyciski należy nacisnąć, aby zastrzelić złoczyńców. Dokumentacja oprogramowania pokazuje, co może zrobić Twój zakup i jak to zrobić.

Formularze podatkowe zawierają wskazówki, jak je prawidłowo wypełnić.

Kosiarki do trawy i odśnieżarki mają przewodniki po produktach, które pokazują, jak uruchomić silniki i gdzie uzupełnić paliwo.

Przejdź do tego, jak zrobić dokumentację użytkownika

Dlaczego dokumentacja użytkownika jest ważna?

Wiesz, że Twój produkt jest świetny. Chcesz, aby Twoi klienci też o tym wiedzieli. Dokumentacja użytkownika pomaga upewnić się, że Twoi klienci lub użytkownicy rzeczywiście dowiedzą się, jak najlepiej wykorzystać Twój produkt.

Niezależnie od tego, jak zapisać dokument, uruchomić silnik, użyć określonego narzędzia, czy nawet ważne informacje dotyczące bezpieczeństwa, dokumentacja użytkownika końcowego jest ważną częścią relacji z klientami.

Dokumentacja użytkownika może zachwycić Twoich klientów

Dokumentacja użytkownika jest łatwa, prawda? To znaczy, po prostu napisz kilka rzeczy o tym, jak korzystać z twojego produktu, i jesteś gotowy!

To nie jest takie proste.

To coś więcej niż materiał „jak to zrobić”. To część doświadczenia klienta. A to oznacza, że ​​jest to również materiał marketingowy.

Jako konsument sam doświadczyłem zarówno świetnych, jak i okropnych przewodników użytkownika. Założę się, że większość z was miała podobne doświadczenia.

Świetna instrukcja obsługi lub przewodnik po produkcie pokazuje Twoim klientom, że zależy Ci nie tylko na tym, czy kupią Twój produkt, ale także na tym, czy rzeczywiście korzystają z niego.

Klienci, którzy czują, że zależy Ci na nich poza ich portfelem, będą do Ciebie wracać.

Jeśli chcesz, aby krzyczeli światu o tym, jak bardzo kochają Twoje produkty i usługi, dostarczenie niesamowitej dokumentacji użytkownika jest istotną częścią tego doświadczenia po zakupie.

Jak dokumentacja użytkownika wspiera Twój zespół wsparcia

Ludzie często kontaktują się z zespołem pomocy technicznej, gdy coś nie działa, ale mogą też dzwonić, gdy po prostu nie mogą czegoś zrozumieć. Posiadanie świetnej dokumentacji użytkownika pomaga zespołowi wsparcia na dwa główne sposoby.

1. Daje im łatwy przewodnik referencyjny

Świetna dokumentacja użytkownika nie musi być przeznaczona tylko dla klientów. Twój zespół pomocy technicznej może korzystać z dokumentacji, aby lepiej wspierać klientów, gdy proszą o pomoc. Gdy dołączysz istotne fragmenty, takie jak spis treści lub indeks, mogą szybko znaleźć potrzebne informacje. A jeśli jest to przeszukiwalny dokument elektroniczny, to jeszcze lepiej! Więcej na ten temat dowiemy się w dalszej części artykułu.

2. Redukuje połączenia

Jak wspomniano powyżej, ludzie często dzwonią do wsparcia, gdy nie mogą czegoś rozgryźć. Ale jeśli klienci sami to rozwiążą, znacznie rzadziej będą potrzebować pomocy. W rzeczywistości ponad 70 procent osób woli korzystać z witryny internetowej firmy w celu uzyskania pomocy niż uzyskać pomoc przez telefon lub e-mail.

Nawet najlepsza dokumentacja nie wyeliminuje wszystkich tych wezwań, ale tworzenie instrukcji obsługi i instrukcji, które są jasne, wyczerpujące i zwięzłe, znacznie zmniejszy ogólną liczbę próśb o pomoc.

Jakie są podstawowe elementy świetnej dokumentacji użytkownika?

Mimo że każdy produkt jest wyjątkowy i będzie wymagał różnych elementów, aby stworzyć naprawdę świetne dokumenty użytkownika, istnieją pewne najlepsze praktyki dotyczące dokumentacji użytkownika końcowego, których należy przestrzegać bez względu na wszystko.

Świetna dokumentacja użytkownika powinna zawierać:

• Zwykły język
• Prostota
• Wizualizacje
• Skupienie się na problemie
• Logiczna hierarchia i przepływ
• Spis treści
• Treść do przeszukiwania
• Dostępna treść
• Dobry projekt
• Informacje zwrotne od prawdziwych użytkowników
• Linki do dalszych zasobów

Zwykły język

Nic nie frustruje klienta bardziej niż czytanie czegoś, czego nie rozumie. Nikt nie chce czuć się głupio, a język, który sprawia, że ​​klient tak się czuje, z pewnością nie jest sposobem na zapewnienie wspaniałego doświadczenia.

Używaj prostego, prostego języka, gdy tylko jest to możliwe, aby pomóc klientom zrozumieć nawet najbardziej złożone koncepcje.

Pamiętaj, pisz dla użytkownika, a nie dla programisty.

Brzmi to jak oczywistość, ale pisanie prostym językiem o produkcie lub usłudze, które znasz, od przodu do tyłu, jest trudniejsze, niż mogłoby się wydawać. Znasz wszelkiego rodzaju żargon, akronimy i inne informacje „poufne”, których klienci prawdopodobnie nie znają. To naturalne, że go używasz.

Ale tutaj możesz wpaść w poważne kłopoty.

Nie zakładaj, że Twój klient wie coś o Twoim produkcie. Nie zakładaj, że znają wszystkie modne hasła techniczne i/lub branżowe, których prawdopodobnie używasz na co dzień w swoim biurze.

Nie pisz tak, jakby były dziećmi, ale zrozum, że mogą potrzebować dodatkowej pomocy, aby naprawdę przyspieszyć. Napisz dokumentację w czytelny sposób.

Prostota

Utrzymuj dokumentację tak prostą, jak to tylko możliwe, aby osiągnąć swój cel. Dotyczy to zarówno treści dokumentu, jak i jego konstrukcji. Długie bloki tekstu i strony ciasno wypełnione pisemną i graficzną treścią mogą sprawić, że przewodniki użytkownika lub podręczniki będą onieśmielające i nieprzyjazne.

Klienci, którzy są zastraszeni Twoimi materiałami użytkownika, znacznie częściej dzwonią do Twojego zespołu wsparcia, niż próbują samodzielnie rozwiązać swoje pytania. Ponadto znacznie mniej prawdopodobne jest, że będą mieli dobre wrażenia klientów.

Wizualizacje

Najlepsza dokumentacja użytkownika doskonale ilustruje frazę „pokaż, nie mów”.

Treści wizualne, w tym obrazy, zrzuty ekranu z adnotacjami, grafiki i filmy, szybko pokazują komuś, jak działa Twój produkt. Nie muszą o tym czytać: widzą to!

Ostatnie badania przeprowadzone przez TechSmith pokazują, że ludzie faktycznie szybciej przyswajają informacje wizualne i lepiej wykonują zadania, gdy instrukcje są dostarczane z treściami wizualnymi lub wideo.

Treść wizualna pomaga również rozbijać długie bloki tekstu i może pomóc wyeliminować wiele tekstu, który sprawia, że ​​wiele przewodników użytkownika lub podręczników wydaje się onieśmielających i nieprzyjemnych.

Popularne sposoby umieszczania treści wizualnych w dokumentacji użytkownika obejmują zrzuty ekranu, nagrania ekranu, filmy instruktażowe i nie tylko.

Czy słyszałeś o uproszczonej grafice? Czasami nazywane uproszczonym interfejsem użytkownika (lub SUI), uproszczona grafika wykonuje obrazy interfejsu użytkownika lub innej grafiki i — tak jak sama nazwa wskazuje — upraszcza je. Ta bardziej podstawowa wersja podkreśla najważniejsze informacje, redukując tekst i grafikę, które nie są ważne, do prostszych kształtów.

A więc coś, co wygląda tak:

Teraz wygląda to tak:

Gdybym próbował pokazać komuś, jak wybrać pozycję menu Podłącz urządzenie mobilne, drugi obraz usuwa cały bałagan i pozwala oczom klienta skupić się tam, gdzie powinny.

Możliwe, że zetknąłeś się już z uproszczoną grafiką i nawet nie zdawałeś sobie z tego sprawy, jak ta z Centrum edukacji G Suite:

Istnieje wiele narzędzi, ale jeśli szukasz wydajnych i łatwych sposobów tworzenia zrzutów ekranu i nagrań ekranu, gorąco polecam pobranie bezpłatnej wersji próbnej Snagit.

Skoncentruj się na problemie do rozwiązania

Każdy produkt rozwiązuje problem. Ale zbyt często jesteśmy tak zakochani w naszych fajnych funkcjach produktów, że chcemy tylko podkreślić to, co może zrobić, a nie to, dlaczego nasi klienci tego potrzebują.

Upewnij się, że pokazujesz użytkownikom, jak wykonywać zadania z Twoim produktem.

Oczywiście będzie to dotyczyć cech produktu, ale podkreśl je w kontekście pomagania użytkownikowi w dotarciu do przyczyny, dla której kupił Twój produkt — aby rozwiązać konkretny problem.

Na przykład nasze samouczki Camtasia i Snagit (tak, samouczki wideo mogą być formą dokumentacji) podkreślają określone funkcje, ale robią to w kontekście tego, dlaczego ktoś może korzystać z tej konkretnej funkcji. Chodzi o to, dlaczego, a nie tylko o to, jak.

Oto świetny przykład…

Logiczna hierarchia i przepływ

Dobra dokumentacja wymaga hierarchii nagłówków i podtytułów, która pozwoli użytkownikowi wiedzieć, co pokaże mu każda sekcja. I ta hierarchia powinna podążać za logicznym przepływem, który pomaga użytkownikowi nauczyć się korzystać z produktu w najbardziej pomocny sposób.

Na przykład prawdopodobnie nie chcesz rozpoczynać dokumentacji od pokazania klientom, jak korzystać z bardziej zaawansowanych funkcji, bez uprzedniego przedstawienia im podstaw działania produktu. Zacznij od łatwych rzeczy, a następnie, gdy użytkownicy będą zdobywać wiedzę, pokaż im zaawansowane funkcje.

Spis treści

Spis treści zapewnia Twoim klientom prosty, skuteczny i znajomy sposób szybkiego znalezienia rozwiązania ich pytania lub problemu. Znajduje się na samym początku dokumentu, więc nie muszą przeszukiwać stron tekstu, aby znaleźć to, czego szukają. Powinien zawierać wszystkie główne nagłówki i podtytuły opisane powyżej.

Umożliwić wyszukiwanie

Był czas, kiedy większość dokumentacji użytkownika była drukowana. Teraz, w erze, w której prawie każdy ma dostęp do smartfona, bardziej sensowne jest tworzenie dokumentacji elektronicznej. Nie oznacza to, że nie możesz również tworzyć wersji do druku, ale wersja elektroniczna oferuje szereg zalet, które omówimy bardziej szczegółowo poniżej.

Podobnie jak spis treści, przeszukiwalna treść zapewnia użytkownikom łatwiejszy dostęp do treści i pomaga im samodzielnie znajdować rozwiązania.

Dostępność

Twórz dostępne treści. Oznacza to zapewnienie, że dokumentacja elektroniczna jest zgodna ze standardami dostępności dla osób niewidomych lub niedowidzących, głuchych lub niedosłyszących lub mogących mieć zaburzenia poznawcze.

Pamiętaj, że wielu Twoich klientów potrzebuje tego, aby zrozumieć i w pełni uzyskać dostęp do Twojej dokumentacji użytkownika. Nie zostawiaj ich w tyle!

Dobry projekt

Daj swoim użytkownikom dokument, który chcą obejrzeć, a chętniej go użyją.

Projektuj materiały z myślą o swoich klientach. Spraw, aby był użyteczny i przyjazny. Unikaj długich akapitów tekstu lub stron, które są zbyt przepełnione treścią. Zostaw białą przestrzeń, która pomoże przełamać monotonię i sprawi, że perspektywa poznania nowego produktu będzie mniej zniechęcająca.

Uwzględnij grafikę i obrazy tak dużo, jak to możliwe, aby pokazać, zamiast mówić klientom, jak korzystać z Twojego produktu. W przypadku dokumentacji elektronicznej użyj wideo i GIF-ów.

Używaj spójnych czcionek i dopełniających się kolorów w wielu dokumentach. Jeśli Twoja organizacja ma przewodnik po stylu (który BARDZO polecam stworzyć, jeśli jeszcze nie istnieje), upewnij się, że Twoja dokumentacja jest z nim zgodna.

Szablony Snagit sprawiają, że tworzenie profesjonalnie wyglądającej dokumentacji użytkownika z serii zrzutów ekranu lub innych obrazów jest niezwykle łatwe. Po prostu zbierz potrzebne obrazy, wybierz Utwórz, a następnie Obraz z szablonu i gotowe.

Snagit jest dostarczany z zestawem darmowych, profesjonalnie zaprojektowanych szablonów, a dzięki TechSmith Assets dla Snagit masz dostęp do znacznie więcej!

Informacje zwrotne od prawdziwych użytkowników i/lub beta testerów

Nie możesz stworzyć naprawdę świetnej dokumentacji użytkownika, dopóki nie wysłuchasz osób spoza organizacji, które faktycznie korzystają z produktów.

Poznaj ich problemy i spróbuj rozwiązać je najlepiej, jak potrafisz. Dowiedz się, co mówią ci, co jest potrzebne, aby jak najlepiej wykorzystać swoje produkty. Chociaż niektóre z nich mogą wydawać się oczywiste, gwarantuję, że nauczysz się rzeczy, o których nawet nie myślałeś.

Linki do innej dokumentacji

Upewnij się, że Twoi klienci mają dostęp do większej liczby zasobów Twojej organizacji dotyczących tego, jak odnieść sukces dzięki Twoim produktom. W przypadku elektronicznej dokumentacji użytkownika może to być tak proste, jak podanie łączy do samouczków, często zadawanych pytań, forów użytkowników i nie tylko.

Ale nawet dokumentacja drukowana może zawierać takie rzeczy, jak adresy stron internetowych i numery telefonów w celu uzyskania dalszej pomocy.

Premia! Dodaj instrukcje krok po kroku

Przewodniki krok po kroku pomagają uniknąć długich bloków tekstu i zapewniają znacznie jaśniejszy sposób pokazania procesu niż próba wyjaśnienia go za pomocą samego tekstu. Są łatwiejsze do naśladowania, łatwiejsze do zrozumienia i oferują znacznie bardziej przyjazne dla użytkownika wrażenia niż po prostu mówienie komuś, jak wykonać zadanie.

I pamiętaj, dołączenie treści wizualnych do instrukcji krok po kroku czyni je jeszcze lepszymi.

Snagit zapewnia łatwe w użyciu narzędzie Step Tool, które pomaga tworzyć świetną dokumentację krok po kroku. Ponadto narzędzie Połącz obrazy umożliwia łączenie pojedynczych zrzutów ekranu i innych obrazów w jeden obraz, co ułatwia edycję i oznaczanie.

Jak stworzyć świetną dokumentację użytkownika

Krok 1: Zaplanuj

Każdy świetny zestaw dokumentów użytkownika zaczyna się od planu. Oto kilka wskazówek, jak dotrzeć tam, gdzie chcesz.

Wiedz od czego zacząć

Wiele osób zakłada, że ​​jeśli znasz swój produkt, możesz po prostu zacząć tworzyć dokumentację. Ale jest w tym o wiele więcej. Zamiast tego zacznij od planu, aby upewnić się, że faktycznie pomagasz swoim użytkownikom.

Przed przystąpieniem do tworzenia dokumentacji należy wziąć pod uwagę kilka kwestii:

• Co powinieneś uwzględnić? Co powinieneś pominąć? (Wskazówka: tutaj opinie użytkowników mogą być NAPRAWDĘ pomocne!)
• W jakiej kolejności należy prezentować informacje? (Pamiętasz szkice esejów ze szkoły? Użyj ich!)
• Jakie inne zasoby będą dostępne? Jak zapewnimy dostęp/linki do nich?
• Kto odpowiada za stworzenie dokumentu? Kto odpowiada za informację zwrotną na temat dokumentu? Kto ma ostateczną zgodę?
• Czy trzeba to przetłumaczyć lub zlokalizować?

Odpowiedzi na te pytania kształtują sposób tworzenia dokumentacji. Planowanie zapewnia płynny proces i lepszy dokument użytkownika.

Poznaj swój produkt

Upewnij się, że znasz swój produkt.

Nie oznacza to, że musisz być absolutnym ekspertem we wszystkim, ale każdy, kto tworzy instrukcję obsługi lub podręcznik użytkownika, powinien mieć praktyczne doświadczenie z produktem.

Polegaj na swoich ekspertach w danej dziedzinie, aby uzyskać bardziej dogłębną wiedzę, ale powinieneś wiedzieć, jak z niej korzystać, zanim spróbujesz uczyć kogoś innego.

Wybierz swój format

Ponadto równie ważny jest ostateczny format dokumentu. Czy będzie tylko drukowany? Czy będzie elektroniczny? Jeśli tak, to gdzie będzie mieszkać?

Nie tak dawno temu prawie cała dokumentacja użytkownika była tylko drukowana. Jeśli jednak nie masz bardzo dobrego powodu, polecam mieć przynajmniej wersję elektroniczną dostępną na swojej stronie internetowej.

Większość użytkowników ma całodobowy dostęp do smartfonów, komputerów lub tabletów i są przyzwyczajeni do znajdowania wszystkiego, co chcą wiedzieć, kiedy tylko chcą. Umieszczenie zasobów użytkownika w Internecie zapewnia im dostęp z dowolnego miejsca, co oznacza, że ​​nie muszą przeszukiwać szuflad lub szafek na akta, aby znaleźć instrukcję obsługi, której nie widzieli od lat.

Poza tym po prostu łatwiej jest udostępnić dokumentację elektroniczną osobom niepełnosprawnym. Wersja tylko drukowana będzie działać dla większości ludzi, ale czy jesteś przygotowany na stworzenie wersji brajlowskiej dla użytkowników, którzy mogą być niewidomi lub niedowidzący? A co z użytkownikami, którzy są niepełnosprawni fizycznie, gdy trudno jest im manipulować przedmiotami rękami?

Istnieją narzędzia ułatwiające wszystkim dostęp do dokumentacji elektronicznej, ale wersje tylko do druku stwarzają znacznie trudniejszy problem z dostępnością.

Ponadto dokumentacja elektroniczna jest znacznie łatwiejsza do aktualizacji, ponieważ znajduje się w Internecie.

Czy powinienem zrobić swoją dokumentację w formacie PDF?

Jeśli chcesz zaoferować wersję PDF swojej dokumentacji do pobrania, w porządku. Ale upewnij się, że jest on również dostępny w Twojej witrynie w formacie innym niż PDF.

Krok 2: Utwórz dokument użytkownika

Po udzieleniu odpowiedzi na wszystkie pytania i podjęciu wszystkich decyzji opisanych powyżej nadszedł czas na stworzenie dokumentacji użytkownika. Nie zamierzam mówić, jak DOKŁADNIE utworzyć dokumentację dla konkretnego produktu, ale należy pamiętać o kilku kluczowych rzeczach.

• Unikaj żargonu i bardzo technicznych terminów, chyba że jest to absolutnie konieczne (a następnie pamiętaj, aby je zdefiniować).
• Unikaj akronimów, chyba że wyjaśnisz, co oznaczają.
• Jeśli to możliwe, używaj powszechnie uznawanego stylu pisania, takiego jak AP lub Chicago. Jeśli Twoja organizacja ma firmowy przewodnik po stylu, skorzystaj z niego.
• Nie zakładaj, że użytkownik wie coś o Twoim produkcie ani o tym, co on robi. POKAŻ im, co muszą wiedzieć, aby odnieść sukces.
• Pamiętaj, aby używać prostego języka. Napisz do poziomu ósmej klasy lub poniżej. Nawet dla zaawansowanych czytelników prosty język prowadzi do szybszego przetwarzania i lepszego zrozumienia.
• Projekt powinien być przyjemny, nie onieśmielający i wciągać użytkownika. Niech CHCĄ korzystać z Twojej dokumentacji.

Krok 3: Przetestuj to

Podręcznik użytkownika jest świetny tylko wtedy, gdy pomaga klientom w korzystaniu z produktu najlepiej, jak potrafią. I nie możesz tego wiedzieć, dopóki ktoś tego nie użyje. Zanim twoje nowe dzieło wyjdzie w świat, chcesz je przetestować. Oto kilka wskazówek!

• Najlepsza praktyka: daj ją grupie prawdziwych użytkowników lub beta testerów i zobacz, jak sobie radzą. Uwzględnij ich opinie w gotowym dokumencie.
• Jeśli nie masz opinii użytkowników na temat testów beta, przetestuj je wewnętrznie, najlepiej z pracownikami, którzy najmniej znają produkt.
• Uzyskaj informacje zwrotne od programistów i inżynierów. Znają produkt lepiej niż ktokolwiek inny i mogą wskazać rzeczy, które mogłeś przegapić.

Krok 4: Dbaj o aktualność dokumentacji

Gdy Twój produkt ulegnie zmianie, musisz aktualizować dokumentację użytkownika. Jak wspomniano powyżej, dokumentacja elektroniczna ma ogromną przewagę nad drukiem. Jednak nawet dokumenty tylko do druku mogą być aktualizowane i udostępniane do pobrania w Twojej witrynie.

Pamiętaj, że Twoje treści są świetne tylko wtedy, gdy są dokładne. Upewnij się, że to, co dajesz swoim klientom, faktycznie pomaga im korzystać z Twojego produktu.

Streszczenie

Jeśli nic więcej nie pamiętasz, pamiętaj, że świetna dokumentacja użytkownika powinna być tworzona, projektowana i prezentowana w sposób najbardziej przydatny dla użytkowników .

Daj im dokumentację, która nadal ich zachwyca i zapewnia taki rodzaj obsługi klienta, jakiego chciałbyś mieć.

Spraw, aby Twoja dokumentacja była przystępna, użyteczna i wizualna.

Często zadawaj pytania