Jak utworzyć podręcznik użytkownika w 2023 r.

Avatar of Author
Tal F
on May 04, 2021 · · filed under Product Documentation Product Management Documentation Portals Product Updates Best Practices
Prosty przewodnik krok po kroku

W końcu zdecydowałeś się napisać nowy przewodnik użytkownika o swoim niesamowitym produkcie.

W 2021 roku okazuje się, że tworzenie przewodnika użytkownika jest nadal w większości procesem ręcznym. Pobierz następną najlepszą aplikację do tworzenia przewodnika użytkownika i zacznij układać zawartość.

Jak więc zacząć, dlaczego zacząć, dlaczego w ogóle potrzebujesz przewodnika użytkownika (duh...)? Postaram się odpowiedzieć na niektóre z najczęstszych pytań dotyczących tworzenia przewodników użytkownika, a także pomóc w stworzeniu pierwszego przewodnika użytkownika w Docsie, ale możesz dosłownie użyć dowolnego innego narzędzia...

Powody i korzyści związane z tworzeniem podręcznika użytkownika

Istnieje wiele powodów, dla których warto tworzyć podręczniki użytkownika. Przewodniki użytkownika są niezwykle przydatne i odgrywają kluczową rolę w świecie konsumentów, elektroniki, oprogramowania i wszystkich aspektów produktów materialnych lub niematerialnych. Przewodniki użytkownika zapewniają użytkownikom proste instrukcje krok po kroku dotyczące korzystania z produktów i/lub ich montażu.

Twoi klienci muszą być poinformowani o produktach, które sprzedajesz, usługach, które świadczysz lub metodach i procedurach, których muszą przestrzegać. Oferują one proces krok po kroku, w którym klienci mogą dowiedzieć się, jak korzystać z różnych funkcji produktu.

Tworzenie odpowiednich instrukcji obsługi ogranicza odpowiedzialność prawną produktów:

Podręczniki użytkownika ograniczają również odpowiedzialność związaną z niewłaściwym użytkowaniem produktów. Podręcznik użytkownika jest bardzo przydatny w przypadku produktów, które mogą spowodować potencjalne obrażenia, a nawet śmierć w wyniku niewłaściwego użytkowania lub montażu produktu. Na przykład: urządzenia wysokiego napięcia, urządzenia generujące ogień, a nawet lasery wymagają obszernych instrukcji obsługi, aby chronić klienta przed niewłaściwym użytkowaniem.

Tworzenie dobrych instrukcji obsługi oszczędza czas:

Dobrej jakości podręczniki użytkownika udostępniają instrukcje dotyczące korzystania z produktów, co może zaoszczędzić wiele czasu zespołowi technicznemu wyjaśniającemu różne kwestie lub zespołom sprzedaży przeprowadzającym prezentacje. Wiele skomplikowanych produktów oprogramowania wymaga dobrych technicznych podręczników użytkownika, aby pomóc swoim klientom nauczyć się korzystać z ich produktów z największym potencjałem. Oprogramowanie jest zwykle bombardowane wieloma funkcjami, a posiadanie odpowiedniej ilości podręczników użytkownika, które dostarczają klientom przydatnych informacji, może pomóc w utrzymaniu klientów i zaoszczędzić czas na wyjaśnianiu, w jaki sposób należy korzystać z różnych aspektów oprogramowania i skomplikowanych produktów.

Edukowanie klientów w zakresie zastosowań produktów:

Edukacja klientów w zakresie produktów technicznych jest bardzo ważna. Bez odpowiednich podręczników użytkownika klienci mogą być zdezorientowani mnóstwem ukrytych funkcji i nie wiedzieć, jak w pełni wykorzystać potencjał produktu technicznego. Przewodniki użytkownika umożliwiają łatwy proces, w którym klienci mogą nauczyć się angażować w różne techniczne aspekty produktu i czuć się komfortowo, mając pod ręką przewodnik użytkownika, gdy muszą zagłębić się w produkty. Pozwoli im to uniknąć stresu związanego z próbami zrozumienia rzeczy bez formalnych pisemnych wskazówek. Również w przypadku produktów niebezpiecznych w użyciu, instrukcje obsługi mogą zawierać ostrzeżenia przed niewłaściwym użyciem produktów w niebezpieczny sposób.

Co sprawia, że przewodnik użytkownika jest świetny

Aby rozpocząć tworzenie podręcznika użytkownika, musisz zrozumieć, jaki problem próbujesz pomóc rozwiązać konkretnemu klientowi. Tworzenie podręcznika użytkownika dla wszystkiego i o wszystkim zamienia go w niezrozumiały bałagan, którego nikt nie zrozumie, w tym jego docelowi odbiorcy. Jeśli spojrzysz na niektóre z najlepszych przykładów przewodników użytkownika online, napisanych przez supergwiazdy, takie jak Stripe lub Slack. Zauważysz szczególny wzór.

Każdy przewodnik użytkownika skupia się na rozwiązaniu konkretnego problemu.

Co więc powinien robić każdy przewodnik? Powinien koncentrować się na prostych czynnościach, które użytkownik może wykonać, postępując zgodnie z tym przewodnikiem. Nie ma potrzeby komplikowania. Wręcz przeciwnie, jeśli skupisz się na prostych czynnościach, które pomogą użytkownikom rozwiązać proste problemy z produktem, otrzymasz zestaw niesamowitych przewodników użytkownika, które pokochają Twoi klienci.

Przyjrzyjmy się więc bliżej kilku przewodnikom użytkownika, aby zrozumieć, jaka jest struktura niesamowitego przewodnika użytkownika, abyśmy mogli potraktować to jako punkt odniesienia do tego, jak sami możemy napisać niesamowity przewodnik użytkownika.

Więc co składa się na świetny podręcznik użytkownika?

Przyjrzyjmy się powyższemu przewodnikowi Managing Book i wymyślmy kilka punktów

Organizowanie instrukcji obsługi

Używanie Docsie do tworzenia przewodników użytkownika

Docsie posiada różne narzędzia i funkcje, które pozwalają tworzyć niesamowite przewodniki użytkownika. Po pierwsze, przyjrzyjmy się, jak działa Docsie. Docsie działa na zasadzie książek, półek i kolekcji.

Kolekcje są używane do izolowania różnych książek, które chcesz pokazać różnym typom klientów. Na przykład ta kolekcja służy do wyświetlania tylko użytkowników biznesowych. Oznacza to, że wybraliśmy tylko 3 książki ze wszystkich książek utworzonych w celu pokazania tych konkretnych klientów.

Jest to przydatne, gdy masz różne typy klientów, którzy korzystają z różnych wersji Twoich produktów. Można to zrobić płynnie na Docsie, klikając trzy kropki obok "Wszystkie" i naciskając przycisk Dodaj.

Po przejściu do paska narzędzi Docsies Collection możesz utworzyć nazwę swojej kolekcji, a także wybrać, jakie instrukcje obsługi chcesz umieścić w tej konkretnej kolekcji. Powodem, dla którego jest to ważne, jest to, że różni klienci mogą potrzebować różnych instrukcji obsługi produktów, a to narzędzie pozwala wyświetlać tylko określone instrukcje obsługi, które muszą zobaczyć.

Teraz zacznijmy pisać swój pierwszy przewodnik użytkownika za pomocą Docsie, odbywa się to za pomocą Docsies "Book".

Potraktuj książkę jako przewodnik użytkownika lub podręcznik. W otwartej książce zobaczysz Edytor, miejsce do tworzenia "Artykułów" i Nagłówków.

Edytor na górze, możliwość tworzenia różnych wersji i języków w lewym górnym rogu i oczywiście "Artykuły i sekcje podtytułów po lewej stronie.

Edytor jest prosty w użyciu, umożliwia dodawanie filmów, zdjęć i kodu za pomocą prostego procesu przeciągania i upuszczania. Pozwala on również na stylizację treści według własnego uznania.

Artykuły są naprawdę łatwe do stworzenia; wystarczy wpisać tytuł. W tym przypadku jest to "Czym jest Docsie", ale możesz wpisać dowolny tytuł swojego podręcznika użytkownika.

Aby utworzyć podrozdziały w przewodnikach użytkownika, które będą wyświetlane jako 1.1,1.2..ext, wystarczy wybrać lokalizację tekstu i ustawić tekst jako "Nagłówek", co odbywa się poprzez kliknięcie H w zakładce edytora.

Docsie pozwala również na tworzenie różnych wersji i języków instrukcji obsługi. Jest to bardzo przydatne i poręczne w przypadku lokalizacji i omawiania różnych zmian w przewodnikach użytkownika produktu.

Po przygotowaniu przewodników użytkownika, napisaniu ich, stylizowaniu ich za pomocą zdjęć, które pomogły wyjaśnić różne aspekty produktów i funkcji, następnym krokiem jest publikacja.

Podsumowując, oto porady i wskazówki dotyczące tworzenia podręcznika użytkownika

Większość oprogramowania i produktów technicznych jest bardzo złożona i wieloaspektowa. Aby rozwiązać tę kwestię podczas tworzenia podręcznika użytkownika dla złożonych produktów, dobrym pomysłem jest podzielenie informacji i instrukcji na mniejsze części. Zasadniczo tworzy się różne małe podręczniki użytkownika i kompiluje je w podręczniku użytkownika.

Klienci nie są zaznajomieni z produktem lub usługą. Im bardziej techniczny produkt, tym bardziej opisowy powinien być podręcznik użytkownika na etapie tworzenia. Niejasne słowa i frazeologia nie będą Twoim przyjacielem w tym procesie. Bądź tak konkretny, jak to tylko możliwe, aby Twój klient mógł zrozumieć nawet najbardziej skomplikowane aspekty Twojego produktu.

Obraz jest wart więcej niż tysiąc słów. Jest to prawda, szczególnie w przypadku instrukcji obsługi i podręczników. Ten krok jest bardzo zaniedbywany przez większość firm, ale posiadanie odpowiednich zdjęć lub migawek funkcji i aspektów produktu podczas wyjaśniania ich w instrukcjach obsługi jest bardzo ważne. W ten sposób klient może zrozumieć, do jakich aspektów produktu się odnosi.

Przewodniki użytkownika mają pomóc klientom zrozumieć różne zastosowania produktów. Wyjaśniaj rzeczy w możliwie najprostszy sposób, aby mogli łatwo zrozumieć ich różne funkcje i aspekty.


Subscribe to the newsletter

Stay up to date with our latest news and products