Jak zbudować najlepszą dokumentację użytkownika

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

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

a dokumentacja użytkownika nie jest tylko dla nowych użytkowników.,

doświadczeni klienci mogą również zapoznać się z instrukcjami obsługi lub przewodnikami po produktach, aby odświeżyć pamięć o funkcji, której często nie używali, lub rozwiązać konkretny problem, który może mieć.

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

oto czego się dowiesz:

• czym jest Dokumentacja użytkownika i dlaczego jest ważna?
• w jaki sposób 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 zawartość wizualna jest tajnym składnikiem najlepszej dokumentacji.
• podstawowe elementy, które zapewniają 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 (zwana także podręcznikami użytkownika końcowego, podręcznikami użytkownika końcowego, instrukcjami obsługi itp.) to treści, które dostarczasz użytkownikom końcowym, aby pomóc im odnieść większy sukces z Twoim produktem lub usługą.

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

Jeśli kiedykolwiek zmontowałeś mebel Ikea, skorzystałeś z Dokumentacji Użytkownika Końcowego.

ale Dokumentacja użytkownika przybiera wiele form.

Gry wideo są dostarczane z instrukcjami, które mówią, które przyciski naciskać, aby strzelać do złych facetów. Dokumentacja oprogramowania pokazuje, co można zrobić i jak to zrobić.,

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

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

przejdź do 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 klienci lub użytkownicy rzeczywiście dowiedzieć się, jak uzyskać jak najwięcej z produktu.,

niezależnie od tego, jak zapisać dokument, uruchomić silnik, użyć określonego narzędzia lub ważnych informacji dotyczących bezpieczeństwa, Dokumentacja użytkownika końcowego jest ważną częścią relacji z klientami.

może zachwycić Twoich klientów

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

to nie takie proste.

to więcej niż tylko materiał „how-to”. To część doświadczenia klienta., A to oznacza, że to także materiał marketingowy.

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

świetna Instrukcja obsługi lub przewodnik po produktach pokazuje Twoim klientom, że zależy Ci nie tylko na tym, czy kupują twój produkt, ale czy mają naprawdę wspaniałe doświadczenie w korzystaniu z niego.

a 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, dostarczanie niesamowitej dokumentacji użytkownika jest istotną częścią tego procesu po zakupie.

Jak Dokumentacja użytkownika wspiera zespół wsparcia

ludzie kontaktują się z zespołem wsparcia, gdy coś nie działa, ale dzwonią również, gdy po prostu nie mogą czegoś wymyślić. Posiadanie świetnej dokumentacji użytkownika pomaga zespołowi wsparcia na dwa główne sposoby.

1., Daje im łatwy przewodnik odniesienia

świetna Dokumentacja użytkownika nie musi być tylko dla klientów. Zespół wsparcia produktu może skorzystać z dokumentacji, aby lepiej wspierać klientów, gdy dzwonią. Po dołączeniu niezbędnych elementów, takich jak spis treści lub indeks, mogą szybko znaleźć potrzebne informacje. A jeśli jest to dokument elektroniczny, który można przeszukiwać, 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 pomocy technicznej, gdy nie mogą czegoś wymyślić., Ale jeśli klienci sami się zorientują, są znacznie mniej prawdopodobne, że będą potrzebować pomocy. W rzeczywistości ponad 70 procent ludzi woli korzystać ze strony internetowej firmy w celu uzyskania pomocy, a nie używać telefonu lub poczty e-mail.

teraz nawet najlepsza dokumentacja nie wyeliminuje wszystkich tych połączeń, ale tworzenie podręczników użytkownika i podręczników, które są kompleksowe, łatwe do zrozumienia, jasne i zwięzłe, znacznie zmniejszy ogólną liczbę połączeń, e-maili, czatów itp.

jakie są podstawowe elementy świetnej dokumentacji użytkownika?,

mimo że każdy produkt jest unikalny i wymaga różnych elementów, aby stworzyć naprawdę świetne dokumenty dla użytkowników, istnieje kilka najlepszych praktyk związanych z dokumentacją użytkownika końcowego, które należy stosować bez względu na wszystko.,

wspaniała Dokumentacja użytkownika powinna zawierać:

• prosty język
• prostota
• wizualizacje
• a focus on the problem
• logiczna hierarchia i przepływ
• spis treści
• przeszukiwalne treści
• dostępne treści
• dobry projekt
• opinie prawdziwych użytkowników
• linki do dalszych zasobów

zwykły język

nic nie frustruje klienta bardziej niż czytanie czegoś, czego nie może zrozumieć. Nikt nie chce czuć się głupi., Sprawianie, że twój klient czuje się w ten sposób, z pewnością nie jest sposobem na promowanie wspaniałego doświadczenia.

używaj prostego, prostego języka, aby pomóc klientom zrozumieć nawet najbardziej złożone pojęcia.

pamiętaj, pisz dla użytkownika, nie dla dewelopera.

brzmi to jak bezmyślne, ale pisanie prostym językiem o produkcie lub usłudze, o której wiesz, jest o wiele trudniejsze, niż mogłoby się wydawać. Znasz wszystkie rodzaje żargonu, akronimów i innych” poufnych ” informacji, których klienci prawdopodobnie nie wiedzą. ,

Ale tam można wpaść w poważne kłopoty.

nie zakładaj, że twój klient wie coś o Twoim produkcie. Nie zakładaj, że znają wszystkie techniczne i / lub branżowe hasła, których prawdopodobnie używasz każdego dnia w biurze. Napisz to dla nich.

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

prostota

maksymalnie uprościć realizację swojego celu. Dotyczy to zarówno treści dokumentu, jak i jego projektu., Długie bloki tekstu i strony szczelnie wypełnione treściami pisanymi i graficznymi mogą sprawić, że podręczniki użytkownika lub podręczniki będą zastraszające i nieprzyjazne.

klienci, którzy są zastraszeni materiałami użytkownika, są znacznie bardziej skłonni zadzwonić do Twojego zespołu wsparcia o pomoc, niż próbować samodzielnie rozwiązać swoje pytania. I, są one znacznie mniej prawdopodobne, aby mieć dobre doświadczenie klienta.

wizualizacje, wizualizacje, wizualizacje

najlepsza Dokumentacja użytkownika doskonale ilustruje powiedzenie „pokaż, nie mów.,”

treści wizualne, w tym obrazy, zrzuty ekranu z komentarzami, grafiki i filmy, szybko pokazują, jak działa twój produkt. Nie muszą o tym Czytać, mogą to zobaczyć!

ostatnie badania TechSmith pokazują, że ludzie szybciej absorbują informacje wizualne i lepiej wykonują zadania, gdy instrukcje są dostarczane z treścią wizualną lub wideo.,

zawartość wizualna pomaga również rozbijać długie bloki tekstu i może pomóc wyeliminować wiele tekstu, co może sprawić, że wiele podręczników użytkownika lub podręczników stanie się onieśmielających i nieprzyjemnych.

popularne sposoby włączania treści wizualnych do dokumentacji użytkownika obejmują zrzuty ekranu, nagrania ekranowe, filmy instruktażowe i inne.

słyszałeś o uproszczonej grafice?, Czasami nazywany uproszczonym interfejsem użytkownika (lub SUI), uproszczona grafika wykonuje obrazy interfejsu użytkownika lub innej grafiki i — 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 dla prostszych kształtów.,

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

teraz wygląda tak:

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

są szanse, że napotkałeś już uproszczoną grafikę i nawet nie zdawałeś sobie z tego sprawy.,

podobnie jak ten z G Suite Learning Center:

istnieje wiele narzędzi, ale jeśli szukasz wydajnych i łatwych sposobów tworzenia zrzutów ekranu i nagrań Ekranowych, nie musisz się martwić.Gorąco polecam pobranie bezpłatnej wersji próbnej Snagit.

skup się na problemie do rozwiązania

każdy produkt rozwiązuje problem., Ale zbyt często tak bardzo kochamy nasze fajne funkcje produktu, wszystko, co chcemy zrobić, to podkreślić, co może zrobić, a raczej dlaczego nasi klienci tego potrzebują.

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

oczywiście będzie to obejmować funkcje produktu, ale zrób to w kontekście pomocy użytkownikowi w dotarciu do przyczyny, dla której kupił produkt — w celu rozwiązania konkretnego problemu.,

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

oto świetny przykład …

logiczna hierarchia i przepływ

dobra dokumentacja wymaga hierarchii nagłówków i podtytułów, która pozwala użytkownikowi wiedzieć, co wyświetli każda sekcja., Hierarchia ta 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 pokazania im podstaw działania produktu. Zacznij od łatwych rzeczy, a następnie, gdy użytkownicy budują swoją wiedzę, pokaż im zaawansowane funkcje.,

spis treści

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

spraw, aby można było go przeszukiwać

był czas, kiedy większość Dokumentacji Użytkownika została wydrukowana., 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 drukowanych, ale wersja elektroniczna oferuje szereg zalet, które omówimy bardziej szczegółowo poniżej.

podobnie jak spis treści, przeszukiwalne treści zapewniają użytkownikom łatwiejszy dostęp do treści i pomagają im znaleźć rozwiązania na własną rękę.

dostępność

Tworzenie dostępnych treści., Oznacza to zapewnienie zgodności dokumentacji elektronicznej ze standardami dostępności dla osób niewidomych lub niedowidzących, głuchych lub niedosłyszących lub z upośledzeniem funkcji poznawczych.

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

Dobry Projekt

Daj swoim użytkownikom dokument, który chcą obejrzeć, A będą bardziej skłonni go użyć.

projektuj materiały z myślą o Twoich klientach. Uczyń go użytecznym i przyjaznym., Unikaj długich akapitów tekstu lub stron, które są zbyt pełne treści. Pozwól, aby biała przestrzeń pomogła przełamać monotonię i sprawić, że perspektywa nauki nowego produktu będzie mniej zniechęcająca.

Dołącz grafikę i obrazy w jak największym stopniu, aby pokazać, a nie powiedzieć klientom, jak korzystać z produktu. W przypadku dokumentacji elektronicznej użyj wideo i plików GIF.

używaj spójnych czcionek i komplementarnych kolorów w wielu dokumentach. Jeśli Twoja organizacja ma przewodnik po stylach (który zdecydowanie polecam), upewnij się, że Twoja dokumentacja jest do niego zgodna.,

szablony Snagit ułatwiają tworzenie profesjonalnie wyglądającej dokumentacji użytkownika z serii zrzutów ekranu lub innych obrazów. Po prostu Zbierz potrzebne obrazy, wybierz Utwórz i obraz z szablonu i jesteś w drodze.

Snagit zawiera mnóstwo darmowych, profesjonalnie zaprojektowanych szablonów, a dzięki zasobom TechSmith dla Snagit masz dostęp do wielu 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 twojej organizacji, które faktycznie korzystają z produktów.,

poznaj ich punkty bólowe i postaraj się je rozwiązać najlepiej jak potrafisz. Dowiedz się, co mówią ci, że muszą wiedzieć, aby jak najlepiej wykorzystać Twoje produkty. Chociaż niektóre z nich mogą być 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 ilości zasobów Twojej organizacji, jak odnieść sukces z produktami. W przypadku elektronicznej dokumentacji użytkownika może to być tak proste, jak udostępnienie linków do samouczków, często zadawanych pytań, forów użytkowników i innych.,

ale nawet dokumentacja drukowana może zawierać takie rzeczy, jak adresy stron internetowych i numery telefonów do dalszego wsparcia.

Bonus! Dodaj instrukcje krok po kroku

Poradniki krok po kroku pomagają uniknąć długich bloków tekstu i zapewniają znacznie jaśniejszy sposób wyświetlania 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 doświadczenie niż po prostu mówienie komuś, jak wykonać zadanie.,

i pamiętaj, że włączenie treści wizualnych w instrukcjach krok po kroku czyni je jeszcze lepszymi.

Snagit zapewnia bardzo łatwe w użyciu narzędzie krok po kroku, 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 utworzyć wspaniałą dokumentację użytkownika

Krok 1: Plan

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

wiesz, od czego zacząć

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

zanim wykonasz dokumentację, oto kilka rzeczy do rozważenia:

• co powinieneś uwzględnić? Co należy pominąć? (Podpowiedź: tutaj opinie Użytkowników mogą być naprawdę pomocne!)
• w jakiej kolejności prezentować informacje?, (Pamiętasz szkice z Gimnazjum? Użyj ich!)
• jakie inne zasoby będą dostępne? W jaki sposób zapewnimy dostęp/linki do nich?
• kto jest odpowiedzialny za stworzenie dokumentu? Kto jest odpowiedzialny za opinie 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 tej dziedzinie, aby uzyskać bardziej dogłębną wiedzę, ale powinieneś wiedzieć, jak z niej korzystać, zanim spróbujesz nauczyć kogoś innego.

Wybierz swój format

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

jeszcze nie tak dawno prawie cała dokumentacja Użytkownika była tylko drukowana. Ale, jeśli nie masz bardzo dobrego powodu, polecam przynajmniej mieć wersję elektroniczną dostępną na swojej stronie internetowej.

większość użytkowników ma 24-godzinny dostęp do smartfonów, komputerów lub tabletów i są przyzwyczajeni do znajdowania wszystkiego, co chcą wiedzieć, kiedy chcą to wiedzieć. Umieszczenie zasobów użytkownika w Internecie daje im dostęp wszędzie tam, gdzie mogą być, co oznacza, że nie muszą przeszukiwać szuflad lub szafek na dokumenty, aby znaleźć instrukcję obsługi, której nie widzieli od lat.,

ponadto łatwiej jest udostępnić dokumentację elektroniczną osobom niepełnosprawnym. Wersja Tylko do druku będzie działać dla większości ludzi, ale czy jesteś gotowy, aby utworzyć wersję brajlowską dla użytkowników, którzy mogą być niewidomi lub niedowidzący? A co z użytkownikami, którzy mają niepełnosprawność fizyczną, gdzie trudno im manipulować przedmiotami rękami?

istnieją narzędzia ułatwiające dostęp do dokumentacji elektronicznej dla wszystkich, ale wersje Tylko do druku zapewniają znacznie trudniejszy problem z dostępnością.,

dodatkowo, dokumentacja elektroniczna jest znacznie łatwiejsza do aktualizacji, ponieważ żyje w sieci.

Jeśli chcesz zaoferować do pobrania wersję PDF swojej dokumentacji, to w porządku. Ale upewnij się, że jest on dostępny na twojej stronie 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, aby utworzyć dokumentację użytkownika. Nie będę zakładał, że powiem Ci, jak dokładnie stworzyć dokumentację dla konkretnego produktu, ale są pewne kluczowe rzeczy, o których należy pamiętać.

• unikaj żargonu i wysoce technicznych terminów, z wyjątkiem sytuacji, gdy jest to absolutnie konieczne (i pamiętaj, aby je zdefiniować).
• unikaj akronimów, chyba że wyjaśnisz, co oznaczają.
• używaj powszechnie uznanego stylu pisania, takiego jak AP lub Chicago, gdy tylko jest to możliwe., Jeśli Twoja organizacja ma firmowy przewodnik stylu, użyj go.
• nie zakładaj, że użytkownik wie cokolwiek o Twoim produkcie ani o tym, co robi. Pokaż im, co muszą wiedzieć, aby odnieść sukces.
• pamiętaj, aby używać prostego języka. Napisz do ósmej klasy. Nawet dla zaawansowanych czytelników prosty język prowadzi do szybszego przetwarzania i lepszego zrozumienia.
• projekt powinien być przyjemny, nie zastraszający i przyciągać użytkownika. Spraw, by chcieli skorzystać z Twojej dokumentacji.,

Krok 3: przetestuj go

podręcznik użytkownika jest świetny tylko wtedy, gdy pomaga klientom korzystać z produktu w najlepszy możliwy sposób. I nie możesz tego wiedzieć, dopóki ktoś tego nie użyje. Zanim twoje nowe stworzenie wyjdzie na ś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ą. Włącz ich opinie do gotowego dokumentu.
• Jeśli nie masz opinii użytkowników testów beta, przetestuj ją wewnętrznie, najlepiej z pracownikami, którzy są najmniej zaznajomieni z produktem.,
• 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: Aktualizuj swoją dokumentację

gdy twój produkt ulegnie zmianie, musisz mieć wszystko na bieżąco. Jak wspomniano powyżej, daje to dokumentację elektroniczną ogromną przewagę nad drukiem. Jednak nawet dokumenty tylko do druku mogą być aktualizowane i udostępniane do pobrania na swojej stronie internetowej.

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.,

podsumowanie

Jeśli nie pamiętasz nic więcej, pamiętaj, że wspaniała Dokumentacja użytkownika powinna być tworzona, projektowana i prezentowana w sposób najbardziej pomocny dla Twoich użytkowników.

przekaż im dokumentację, która nadal ich zachwyca i zapewnia takie wrażenia klienta, jakie chciałbyś mieć.

spraw, aby Twoja dokumentacja była dostępna, użyteczna, by była wizualna.

często zadawaj pytania

Uwaga: Ten post został pierwotnie opublikowany w sierpniu 2019, ale został zaktualizowany we wrześniu 2020 w celu zapewnienia jasności i uwzględnienia nowych informacji.