Jak stworzyć podręcznik użytkownika: od zera do bohatera (pełny przewodnik)

Nie wiesz, jak stworzyć instrukcję obsługi, aby pomóc klientom uzyskać większą wartość z Twojego produktu?

Instrukcja obsługi to treść, która pomaga Twoim klientom (lub pracownikom) efektywnie korzystać z Twojego produktu lub usługi. Możesz go również zobaczyć jako podręcznik użytkownika, instrukcję obsługi, instrukcję produktu i tak dalej.

Oprócz pomagania klientom w efektywnym korzystaniu z produktu, stworzenie wysokiej jakości instrukcji obsługi może również pomóc w ograniczeniu liczby zgłoszeń do obsługi klienta i pomocy technicznej, ponieważ użytkownicy mogą rozwiązywać swoje problemy bez kontaktowania się z pomocą techniczną.

Z tego szczegółowego przewodnika dowiesz się, jak stworzyć instrukcję obsługi, która pomoże Twoim klientom osiągnąć sukces.

Aby tak się stało, oto wszystko, co omówimy:

• Różne rodzaje instrukcji obsługi
• Gdzie opublikować instrukcję obsługi
• Jak stworzyć instrukcję obsługi

Zakopmy się!

Różne typy instrukcji obsługi

Istnieją różne rodzaje instrukcji obsługi, w tym zarówno przeznaczone dla klientów, jak i treści wewnętrzne.

Zanim zaczniesz, ważne jest, aby zrozumieć, jaki rodzaj podręcznika chcesz utworzyć, ponieważ wpłynie to na podejście do treści.

Oto krótkie podsumowanie różnych typów instrukcji obsługi:

• Instrukcja obsługi – klasyczna instrukcja obsługi uczy użytkowników obsługi produktu.
• Podręcznik szkoleniowy – podręcznik szkoleniowy uczy użytkowników, jak wykonać określone zadanie lub wykonać określoną pracę.
• Instrukcja obsługi – instrukcja obsługi to zazwyczaj wewnętrzna instrukcja, która dokumentuje działania Twojej firmy.
• Instrukcja serwisowa – instrukcja serwisowa koncentruje się na nauczeniu użytkowników, jak prawidłowo konserwować produkt w różnych momentach cyklu życia produktu.
• Standardowe procedury operacyjne (SOP) – SOP to wewnętrzne instrukcje, które uczą członków organizacji, jak prawidłowo realizować określone procesy „we właściwy sposób”.

W przypadku poniższych instrukcji zajmujemy się głównie tworzeniem ogólnodostępnej instrukcji obsługi. Jednak poniższe podstawowe zasady mają zastosowanie do każdego rodzaju instrukcji obsługi.

Gdzie opublikować instrukcję obsługi

Miejsce opublikowania instrukcji obsługi zależy od rodzaju tworzonej instrukcji obsługi.

W przypadku instrukcji obsługi przeznaczonych dla klientów prawie zawsze będziesz chciał opublikować je na swojej stronie internetowej. W ten sposób użytkownicy mogą uzyskać dostęp do instrukcji z dowolnego miejsca.

Co więcej, publikowanie treści podręcznika użytkownika w Internecie umożliwia tworzenie bardziej przyjaznych dla użytkownika doświadczeń niż w przypadku fizycznej instrukcji obsługi, na przykład dodawanie klikalnych spisów treści i sugestii wyszukiwania w czasie rzeczywistym.

Jednak w przypadku produktów fizycznych możesz również chcieć dołączyć fizyczną instrukcję obsługi jako uzupełnienie instrukcji internetowej.

W przypadku wewnętrznych instrukcji obsługi zazwyczaj chcesz ukryć je przed publicznym widokiem.

Jednym ze sposobów osiągnięcia tego celu jest udostępnianie ich wyłącznie w firmowym intranecie. Jednak przy tak wielu osobach pracujących z domu może to być trudne, chyba że Twoja firma ma własną konfigurację VPN.

Zamiast tego możesz rozważyć zabezpieczenie zawartości hasłem, wymagając od pracownika zalogowania się na konto użytkownika lub po prostu dodając hasło, aby uzyskać dostęp do strony.

W przypadku fizycznych instrukcji obsługi można skorzystać z dedykowanego narzędzia do zarządzania wiedzą, które pomoże w publikowaniu bardziej złożonych instrukcji. Lub, w przypadku prostszych instrukcji obsługi, możesz po prostu pisać w Dokumentach Google i stamtąd publikować — nasza kolekcja technicznych narzędzi do pisania zawiera kilka przydatnych narzędzi, które ułatwią Ci życie.

Aby opublikować instrukcję obsługi online, możesz użyć większości oprogramowania do dokumentacji lub bazy wiedzy. Jeśli potrzebujesz narzędzia, które może obsługiwać zarówno publiczne, jak i wewnętrzne instrukcje użytkownika, możesz rozważyć wtyczkę Heroic Knowledge Base typu open source do WordPress. Porozmawiamy o tym bardziej szczegółowo w samouczku.

Oto przykład instrukcji obsługi online z Heroic Knowledge Base (oraz o Heroic Knowledge Base):

Mówiąc o samouczku…

Jak stworzyć instrukcję obsługi w sześciu krokach

Teraz, gdy masz już pewne podstawowe informacje, przejdźmy do tworzenia instrukcji obsługi, zaczynając od zera i przechodząc aż do gotowej instrukcji obsługi.

1. Stwórz swoje persony użytkownika

Zanim zaczniesz tworzyć jakiekolwiek treści, chcesz zrozumieć, dla kogo są one przeznaczone , co możesz osiągnąć, tworząc persony użytkowników.

Prawdopodobnie masz już dobre pojęcie o tym, kim są Twoi klienci, ale warto to zapisać, aby naprawdę skoncentrować swoje wysiłki.

Dlaczego to jest ważne?

Oto przykład:

Istnieje duża różnica między tworzeniem treści technicznych dla inżynierów mechaników a tworzeniem treści technicznych dla użytkowników nietechnicznych.

W przypadku większości produktów różnice nie będą tak wyraźne. Ale nadal ważne jest, aby zrozumieć osobowości swoich klientów, aby upewnić się, że instrukcja obsługi ma sens dla osób, które będą z niej korzystać.

2. Zidentyfikuj kluczowe problemy i cele

Gdy już zrozumiesz, kim są Twoi klienci, następnym krokiem jest zrozumienie, co próbują osiągnąć za pomocą instrukcji obsługi, którą zamierzasz stworzyć.

To znaczy, jaki jest cel końcowy (lub cele końcowe) osób, które będą czytać ten podręcznik?

Zrozumienie tego jest ważne, ponieważ celem podręcznika powinna być pomoc użytkownikom w osiągnięciu tego celu tak skutecznie, jak to możliwe.

W niektórych przypadkach ten cel końcowy może być konkretną rzeczą. Na przykład, jeśli masz narzędzie do zarządzania mediami społecznościowymi, może to być „planowanie postu w mediach społecznościowych”.

W innych może to być bardziej abstrakcyjny cel, na przykład „poprawa naszych procesów zarządzania projektami”.

W przypadku większych produktów użytkownik może próbować osiągnąć wiele rzeczy, co prowadzi nas do następnej sekcji.

3. Utwórz strukturę logiczną i hierarchię

Teraz, gdy już wiesz, kim są Twoi klienci i co chcą osiągnąć, możesz zacząć planować strukturę instrukcji obsługi.

Chcesz stworzyć strukturę, która poprowadzi użytkowników od „zera” do osiągnięcia celu końcowego, który wymieniłeś w poprzedniej sekcji.

Oto kilka wskazówek, które pomogą Ci to zrobić:

1. Zastanów się, jak pomóc klientom jak najszybciej zacząć czerpać korzyści z Twojego produktu.
2. Wyciągnij z tego swoją osobistą wiedzę. Oczywiście wiesz dużo o swoim produkcie, ale Twoi klienci nie będą mieli takiej wiedzy.
3. Pamiętaj, aby opisać wszelkie typowe problemy lub niejasne szczegóły, które mogą napotkać Twoi klienci podczas próby korzystania z Twojego produktu. Powinny one być rozwiązywane logicznie w momentach, w których klienci najprawdopodobniej napotkają problemy.

4. Napisz treść instrukcji obsługi

Po zaplanowaniu treści możesz przystąpić do pisania.

W zależności od wielkości Twojego produktu/organizacji możesz napisać wszystko sam. Lub może być konieczna współpraca z innymi członkami zespołu w celu napisania zawartości.

Oto kilka ogólnych najlepszych praktyk dotyczących instrukcji obsługi, które należy wziąć pod uwagę podczas pisania instrukcji obsługi:

• Użyj szablonu, aby zapewnić spójne formatowanie . Stworzenie sformatowanego szablonu nie tylko przyspiesza pracę, ale także gwarantuje, że każdy artykuł w podręczniku jest spójny z pozostałymi.
• Dołącz materiały wizualne (obrazy i filmy), aby pomóc użytkownikom . Dobrze opatrzony adnotacjami obraz lub GIF może być bardziej pomocny niż samodzielna instrukcja tekstowa, bez względu na to, jak szczegółowy i dokładny jest tekst.
• Używaj prostego języka i unikaj żargonu . Lub, gdy żargon jest całkowicie nieunikniony, pamiętaj o jego wyjaśnieniu.
• Mów krótko i na temat . Twoim celem w przypadku instrukcji obsługi powinno być pełne omówienie tematu, ale w jak najmniejszej liczbie słów. Nie pomijaj ważnych informacji, ale bezwzględnie wycinaj niepotrzebne treści.
• W miarę możliwości używaj wypunktowań i list w celu uzyskania instrukcji . Korzystanie z listy numerowanej lub wypunktowanej może ułatwić użytkownikom śledzenie przewodnika. Lub, jeśli potrzebujesz więcej szczegółów, niż pozwala na to lista, możesz nadać każdemu krokowi własny podtytuł.
• Użyj aktywnego głosu . Głos pasywny może być szczególnie mylący w przypadku instrukcji zawartych w instrukcji obsługi. Na tym polega różnica między „Produkt można włączyć, naciskając czerwony przycisk” a „Produkt można włączyć, naciskając czerwony przycisk”. Ten ostatni przykład (głos aktywny) jest jaśniejszy i ułatwia czytelnikowi wczuć się w treść instrukcji.

Na koniec zawsze dobrze jest przetestować instrukcje zawarte w instrukcji obsługi, tak jakbyś był pierwszym użytkownikiem.

Oznacza to, że po napisaniu artykułu wróć i postępuj zgodnie z instrukcjami krok po kroku, aby upewnić się, że niczego nie przegapiłeś.

5. Opublikuj swoją instrukcję obsługi

Ostatnim krokiem po utworzeniu treści jest opublikowanie instrukcji obsługi, aby była łatwo dostępna dla klientów.

Sposób, w jaki to zrobisz, będzie zależał od rodzaju oferowanego produktu. Na przykład możesz chcieć dołączyć fizyczną wersję instrukcji, jeśli wysyłasz produkty fizyczne.

Jednak bez względu na to, jaki rodzaj produktu oferujesz, będziesz chciał opublikować swoją instrukcję obsługi online, aby ludzie mogli ją łatwo znaleźć.

Aby Ci w tym pomóc, możesz skorzystać z oprogramowania bazy wiedzy/dokumentacji.

Na przykład dzięki wtyczce Heroic Knowledge Base WordPress możesz opublikować swoją instrukcję obsługi za pomocą oprogramowania WordPress typu open source.

To podejście typu open source zapewnia pełną własność i kontrolę nad platformą, a jednocześnie zapewnia wiele przydatnych narzędzi, które pomogą klientom efektywniej poruszać się po instrukcji obsługi:

• Organizacja kategorii – możesz łatwo uporządkować instrukcję obsługi w logiczne kategorie i uporządkować te kategorie za pomocą przeciągania i upuszczania.
• Sugestie wyszukiwania w czasie rzeczywistym – jeśli klienci chcą przejść bezpośrednio do konkretnego samouczka, mogą po prostu rozpocząć wpisywanie wyszukiwania i zobaczyć sugestie wyszukiwania na żywo na podstawie ich zapytań.
• Automatyczny spis treści – wtyczka automatycznie wygeneruje klikalny spis treści dla każdego artykułu w instrukcji obsługi, co pomaga czytelnikom przejść bezpośrednio do odpowiedniej dla nich sekcji.
• Łatwe objaśnienia/formatowanie – możesz łatwo dodawać objaśnienia i inne formatowanie, aby zwrócić uwagę na kluczowe elementy w swoich artykułach.
• Widżet błyskawicznych odpowiedzi — oprócz utworzenia dedykowanej strony podręcznika użytkownika w witrynie można również dodać widżet błyskawicznych odpowiedzi z możliwością przeszukiwania, który umożliwia odwiedzającym przeglądanie treści podręcznika użytkownika z dowolnego miejsca w witrynie.

Jeśli chcesz zobaczyć jeszcze więcej opcji oprogramowania, które pomogą Ci opublikować instrukcję obsługi, możesz przeczytać nasze posty na temat najlepszego oprogramowania bazy wiedzy i najlepszych narzędzi do dokumentacji.

6. W razie potrzeby zaktualizuj i popraw swoją instrukcję obsługi

Stworzenie instrukcji obsługi nie jest jednorazowym wysiłkiem. W przyszłości będziesz musiał poświęcić czas na sprawdzanie i aktualizowanie treści.

Istnieją dwa główne powody, dla których konieczna może być aktualizacja instrukcji obsługi:

1. Dodałeś nowe funkcje do swojego produktu lub zmieniłeś sposób działania istniejących funkcji/interfejsów.
2. Chcesz ulepszyć treść instrukcji obsługi, aby była bardziej pomocna.

Pierwsza sytuacja jest oczywista – jeśli w jakiś sposób zmienisz swój produkt, musisz zaktualizować instrukcję obsługi, aby uwzględnić te zmiany.

Należy jednak wziąć pod uwagę również drugą sytuację. Chociaż bardzo się starasz, prawdopodobnie nie uda ci się sprawić, by każdy artykuł w instrukcji obsługi był doskonały od pierwszego dnia.

Aby lepiej pomóc swoim użytkownikom, warto aktualizować i korygować treści podręczników o niskiej skuteczności, aby były bardziej przydatne.

Jeśli opublikujesz swoją instrukcję obsługi za pomocą narzędzia takiego jak Heroic Knowledge Base, zawiera ona wbudowane oceny przydatności artykułów, dzięki czemu możesz łatwo zobaczyć, które artykuły wymagają poprawy. Użytkownicy mogą również zostawić opinię tekstową na temat artykułu, która może wskazać konkretne części artykułu, które nie pomagają tak bardzo, jak mogłyby:

Może Ci też brakować artykułów na tematy, z którymi użytkownicy mają problemy. Aby pomóc Ci znaleźć te brakujące tematy, Heroic Knowledge Base zawiera również wbudowaną analitykę wyszukiwania, dzięki której możesz śledzić, które wyszukiwania nie mają żadnych wyników w temacie ( jak również ogólne wyszukiwania ):

Stwórz swoją instrukcję obsługi już dziś

Nauczenie się tworzenia instrukcji obsługi jest ważne, jeśli chcesz zapewnić swoim klientom sukces.

Dzięki wskazówkom i najlepszym praktykom zawartym w tym poście powinieneś mieć wiedzę potrzebną do rozpoczęcia pracy z instrukcją obsługi.

Aby w prosty sposób opublikować instrukcję obsługi online i pomóc swoim klientom w poruszaniu się po niej, możesz użyć WordPress i wtyczki Heroic Knowledge Base.

Heroic Knowledge Base ułatwia publikowanie artykułów i organizowanie ich w razie potrzeby. Ponadto Twoi klienci mogą korzystać z przydatnych funkcji, takich jak sugestie wyszukiwania na żywo, automatyczny spis treści i nie tylko.

Zacznij już dziś, a wkrótce opublikujesz instrukcję obsługi.

Jeśli jesteś zainteresowany tworzeniem dokumentacji w celu poprawy wewnętrznej wiedzy w Twojej firmie, być może zainteresuje Cię również nasz poradnik dotyczący publikowania podręcznika szkoleniowego dla Twojego personelu.