Jak pisać jasne i zwięzłe instrukcje obsługi
Co to jest instrukcja obsługi?
Istnieją różne nazwy instrukcji obsługi. Dokumenty techniczne, instrukcje konserwacji i instrukcje obsługi to nazwy, które odnoszą się do tego samego elementu. Instrukcja obsługi została stworzona, aby pomóc klientom w prawidłowym korzystaniu z produktu lub usługi lub rozwiązywaniu problemów pojawiających się podczas użytkowania. Mogą być udostępniane w formie drukowanej, cyfrowej lub w obu formatach.
Instrukcje obsługi zapewniają użytkownikowi końcowemu wyczerpujące instrukcje krok po kroku oraz pomoc w rozwiązywaniu problemów. Spis treści powinien znajdować się w każdej instrukcji obsługi, ponieważ jest to materiał referencyjny, a nie książka, którą należy przeczytać od początku do końca. Do instrukcji obsługi należy dodać przewodnik szybkiego startu lub samouczek uruchamiania, aby użytkownicy mogli swobodnie rozpocząć korzystanie z produktu.
rodzaje instrukcji obsługi
Podręczniki użytkownika mogą być tworzone dla różnych tematów i celów. Oto niektóre z twoich możliwości, więc spójrzmy na nie.
- Instrukcja obsługi
Instrukcja obsługi to rodzaj instrukcji obsługi, która zawiera proste instrukcje dotyczące użytkowania produktu zgodnie z jego przeznaczeniem. - Podręcznik szkoleniowy
Ten rodzaj podręcznika użytkownika zawiera listę wskazówek dotyczących zakończenia określonego zadania, projektu lub zadania. - Instrukcja serwisowa
Instrukcje serwisowe to podręczniki użytkownika, które opisują, jak dbać i konserwować maszynę lub sprzęt w różnych okresachtages swojej żywotności. - Instrukcja obsługi
Instrukcje obsługi to publikacje techniczne, które wyjaśniają, jak prawidłowo używać lub obsługiwać produkt. - Instrukcja obsługi
Role, obowiązki i procedury specyficzne dla firmy lub organizacji są opisane w instrukcjach operacyjnych. - Podręcznik polityki organizacyjnej
Podręcznik polityki organizacyjnej to dokumentacja określająca zasady, praktyki i najlepsze praktyki firmy. - Podręcznik standardowych procedur operacyjnych (SOP).
Użytkownicy korzystają ze szczegółowych instrukcji dotyczących wykonywania ustalonych procedur zawartych w standardowym podręczniku procedur operacyjnych.
Dlaczego Twoja firma potrzebuje instrukcji obsługi?
Ludzie są lepiej przygotowani do samodzielnego radzenia sobie z problemami przy pomocy instrukcji obsługi. Przyzwoita instrukcja obsługi może dać Twoim klientom narzędzia, których potrzebują, aby szybko i skutecznie osiągnąć pożądaną wartość z Twojego produktu lub usługi w dzisiejszej kulturze natychmiastowej gratyfikacji.
Doskonała obsługa klienta musi być uzupełniona o instrukcje obsługi. Pisanie doskonałych instrukcji obsługi zapewni następującą korzyśćtagdla Twojej firmy:
- Aby uprościć wdrażanie i szkolenie
Dobrze napisane podręczniki użytkownika mogą uprościć procedury wdrażania i szkolenia. Zgadza się, opracowując i wdrażając najwyższej klasy instrukcje obsługi, zarówno Twoi pracownicy, jak i konsumenci mogą zyskać.
Twoja firma może korzystać z przewodników użytkownika, aby pomóc nowym pracownikom przejść przez niektóre procesy i systemy, które są częścią ich nowych ról, zamiast tylko organizować trudne sesje szkoleniowe, które wymagają znacznego czasu i nakładów finansowych. Ponieważ pracownicy mogą uczyć się podczas wykonywania obowiązków związanych z ich stanowiskiem dzięki przewodnikom użytkownika, może być mniej godzin straconych podczas onboardingu. - Aby zmniejszyć wydatki na wsparcie
Podręczniki użytkownika są doskonałym dodatkiem do działań związanych z obsługą klienta dla konsumenta, ale służą również właścicielowi firmy jako element systemu obsługi klienta.
Klienci z większym prawdopodobieństwem od razu znajdą rozwiązanie i rzadziej będą musieli kontaktować się z technikiem lub przedstawicielem w celu uzyskania specjalistycznej pomocy, jeśli zapewnisz im szybki dostęp do przeszukiwalnej instrukcji obsługi. - Aby zaoszczędzić czas
Zarówno Twoi klienci, jak i pracownicy, od personelu podstawowego po kierownictwo, mogą zaoszczędzić czas, korzystając z instrukcji obsługi. Kiedy instrukcje obsługi są dostępne dla Twoich klientów, nie będą musieli tracić czasu na szukanie informacji o tym, jak korzystać z produktu, ponieważ od razu będą mieli bezpośredni dostęp do tych informacji.
Kiedy Twoi pracownicy są wyposażeni w przydatne instrukcje obsługi, nie muszą tracić czasu na samodzielne szukanie rozwiązań lub monopolizowanie uwagi swoich współpracowników i menedżerów zapytaniami, ponieważ mają dostęp do rozwiązań bezpośrednio w swojej instrukcji obsługi! - Aby zminimalizować odpowiedzialność
Jednym ze sposobów wykazania, że dokładnie przetestowałeś swój produkt i wiesz, jak go bezpiecznie używać, jest napisanie i dystrybucja instrukcji obsługi. Może to znacznie obniżyć wszelkie zobowiązania związane z produkcją czegoś dla ogółu społeczeństwa.
Spisanie ostrzeżeń i środków ostrożności oraz udostępnienie ich użytkownikom za pośrednictwem instrukcji obsługi jest skutecznym (choć nie niezawodnym) sposobem na uniknięcie problemów prawnych związanych z urazami lub innymi szkodami spowodowanymi niewłaściwym użytkowaniem, jeśli sprzedawany produkt może być niebezpieczny dla użytkowników (pomyśl grzejniki, elektronarzędzia itp.).
Jakie elementy składają się na najlepsze instrukcje obsługi?
Istnieją pewne najlepsze praktyki w zakresie dokumentacji użytkownika końcowego, których należy przestrzegać bez względu na wszystko, nawet jeśli każdy produkt jest wyjątkowy i będzie wymagał odrębnych komponentów, aby wygenerować naprawdę doskonałą dokumentację użytkownika.
- Zwykły język
Nic bardziej nie zirytuje Twoich klientów — poza brakiem oferty — niż odkrycie, że ich instrukcja obsługi jest pełna żargonu i trudnego do zrozumienia języka. Twoje instrukcje dla użytkownika są trudne w użyciu ze względu na te wybory językowe, które również nie promują doskonałej obsługi klienta. Upewnienie się, że piszesz dla użytkownika, a nie programisty, jest kluczowym elementem tworzenia świetnych przewodników użytkownika. Nie zakładaj, że użytkownik końcowy coś wie lub zna. Akronimy, żargon i terminologia biurowa sprawią, że Twoi klienci poczują się źle poinformowani, sfrustrowani i nieprzygotowani. Najlepszym miejscem do stworzenia instrukcji obsługi jest znalezienie równowagi między niepisaniem tak, jakby Twoi klienci byli dziećmi (o ile oczywiście nimi nie są!) język. - Prostota
Pisanie podręcznika użytkownika wymaga zachowania prostoty. Koncepcja ta powinna znaleźć odzwierciedlenie zarówno w treści, jak iw projekcie. Jeśli przeładujesz swoją dokumentację skomplikowanymi obrazami i długimi fragmentami tekstu, wyda się ona zbyt wyrafinowana i trudna do zrozumienia. Ten rodzaj instrukcji obsługi może zastraszyć użytkownika i skłonić go do skontaktowania się z infolinią zamiast samodzielnego rozwiązywania problemu. - Wizualizacje
Maksyma „Pokaż, nie mów” jest kamieniem węgielnym pisania instrukcji obsługi. Zrzuty ekranu, filmy i inne treści wizualne z adnotacjami są niezwykle pomocne w zrozumieniu koncepcji. Często o wiele bardziej przydatne jest zobaczenie czegoś w akcji niż przeczytanie o tym. Wizualizacje nie tylko dzielą długie fragmenty tekstu, ale także zmniejszają ilość tekstu w instrukcjach obsługi, która może być przerażająca. Wykazano, że ludzie zapamiętują informacje wizualne o 7% szybciej niż informacje pisane. W badaniu przeprowadzonym przez firmę Techsmith wykazano również, że 67% osób wykonywało zadania skuteczniej, gdy otrzymało instrukcje zawierające zrzuty ekranu z adnotacjami, a nie same słowa w celu przekazania informacji. - Skoncentruj się na problemie do rozwiązania
Jest całkiem prawdopodobne, że ktoś kupił Twój produkt, aby rozwiązać problem. Należy skupić się na tym zagadnieniu podczas opracowywania instrukcji obsługi, która zostanie dołączona do produktu. Zamiast wyliczać i omawiać wszystkie funkcje oferowane przez Twój produkt lub intrygujące elementy projektu, które zastosowałeś, poinformuj o nich swoich użytkowników w sposób ułatwiający korzystanie z produktu. Opisując rozwiązywany problem, umieść go w kontekście cech i zalet swojego produktu. - Przepływ logiczny i hierarchia
Aby użytkownik zrozumiał, czego dowie się z każdej sekcji instrukcji obsługi, użyj nagłówków i podtytułów, które mają przejrzystą strukturę hierarchiczną. Aby bez wysiłku przeprowadzić klientów przez wszystkie potrzebne informacje od początku do końca, wybrana przez Ciebie hierarchia powinna przebiegać logicznie. Upewnij się, że zaczynasz od podstaw i wprowadzasz logiczny postęp w kierunku bardziej zaawansowanych funkcji produktu. - Spis treści
Podręcznik użytkownika będzie najbardziej pomocny dla czytelników, jeśli zaczyna się od spisu treści. Bez konieczności przekopywania się przez wiele stron informacji niezwiązanych z bieżącym problemem, z którym się borykają, szybkie i łatwe przeglądanie dokumentu jest znajomym podejściem. - Spraw, by można go było przeszukiwać
Nawet jeśli możesz wydrukować instrukcje obsługi, prawdopodobnie dokumentacja cyfrowa będzie Twoim głównym priorytetem. Jest całkiem prawdopodobne, że Twoje instrukcje obsługi będą najczęściej wykorzystywane w formacie cyfrowym w świecie, w którym większość ludzi ma przy sobie smartfon przez cały czas. Dodanie funkcji przeszukiwania do cyfrowych instrukcji obsługi zapewni zachwycającą łatwość obsługi użytkownikom, którzy chcą rozwiązać problem, uzyskując do nich dostęp, podobnie jak spis treści służy do kierowania użytkowników we właściwe miejsce w dokumencie drukowanym. - Dostępność
Możliwe, że niektóre osoby, które potrzebują Twojej instrukcji obsługi, mogą skorzystać z dodatkowej pomocy, aby zapewnić jej prawidłowe działanie. Niezależnie od tego, czy są one wymagane przez prawo, wymogi dostępności są generalnie dobrą praktyką. Utrzymanie wymagań dostępności w instrukcjach obsługi to po prostu doskonała praktyka biznesowa. Projektowanie przewodników użytkownika z treścią dostępną dla użytkowników, którzy mogą mieć problemy wizualne, dźwiękowe lub poznawcze, ma kluczowe znaczenie. - Dobrze zaprojektowany
Tworząc przewodniki użytkownika, weź pod uwagę odbiorców. Będą o wiele bardziej skłonni do efektywnego wykorzystania tego, jeśli stworzysz coś, na co lubią patrzeć! Unikaj długich bloków tekstu i zapewnij dużo białej przestrzeni. Połączenie tych dwóch cech może sprawić, że konsumenci będą wydawać się mniej przerażający, a uczenie się czegokolwiek nowego będzie bardziej ekscytujące niż groźne. Podejście „pokaż, nie mów”, które opisaliśmy wcześniej, ma zastosowanie również tutaj. Zarówno w przypadku drukowanych, jak i cyfrowych instrukcji obsługi dodawanie materiałów wizualnych i zdjęć do tekstu jest świetną alternatywą. W przypadku cyfrowych instrukcji obsługi filmy i pliki GIF są interesujące i stanowią pomocny element. Jeśli Twoja firma ma przewodnik po stylach, Twój projekt powinien być zgodny z nim; w przeciwnym razie, jeśli działasz bez niego, ważne jest, aby zachować spójność instrukcji obsługi. Czcionka i schematy kolorów używane w całym dokumencie, a najlepiej we wszystkich podręcznikach użytkownika, powinny być spójne. - Komentarze od rzeczywistych klientów lub beta testerów
Nie będziesz w stanie określić, czy przygotowane przez Ciebie instrukcje obsługi są tak skuteczne, jak to tylko możliwe, dopóki nie poszukasz i nie wysłuchasz opinii osób, które będą faktycznie używać Twojego produktu. Podręczniki użytkownika, które opracujesz dla swojego produktu, powinny uwzględniać problemy, jakie ludzie mają z nim. Możesz nauczyć się czegoś, co wydaje się niezwykle oczywiste, ale jest o wiele większa szansa, że nauczysz się czegoś, co pomoże ci zrozumieć potrzeby klientów, do których próbujesz dotrzeć.
Jak napisać instrukcję obsługi?
Przygotowanie instrukcji obsługi to kluczowe zadanie, które może mieć duży wpływ zarówno na Twoją firmę, jak i konsumentów, którym chcesz służyć. Uprościliśmy proces opracowywania instrukcji obsługi, abyś mógł z łatwością śledzić jego treść, ponieważ może to być przytłaczające.
- Zidentyfikuj użytkowników
Znalezienie odbiorcy Twojej komunikacji jest niezbędnym początkowym krokiem, podobnie jak w przypadku każdej innej komunikacji, którą generujesz. Docelowi odbiorcy podręcznika użytkownika pomogą Ci zdecydować o takich kwestiach, jak ton, poziom szczegółowości i sposób dostarczenia treści. Pisanie podręcznika użytkownika dla użytkownika końcowego produktu znacznie różni się od pisania podręcznika dla inżyniera technicznego. Pierwszym krokiem jest określenie odbiorców. - Skoncentruj się na problemie
Instrukcje obsługi są tworzone, aby pomóc w rozwiązywaniu problemów lub instruowaniu kogoś, jak zrobić coś nowego. Musisz dokładnie określić, do czego ma służyć twoja instrukcja obsługi, i upewnić się, że się na tym koncentrujesz.
Może być kuszące poszerzenie tematu i omówienie wielu funkcji lub zastosowań Twojego produktu. Może to frustrować użytkowników i prowadzić do wezwań na linię obsługi klienta, zaciemniając autentyczną odpowiedź, której potrzebują.
Jeśli Twoim klientem jest konsument uczący się obsługi produktu lub technik, który musi go naprawić, skoncentruj się na precyzyjnym rozwiązaniu, którego będzie potrzebować. - Zastosuj podejście sekwencyjne
Instrukcje zawarte w instrukcji obsługi powinny być ułożone w kolejności niezbędnej do zakończenia bieżącej pracy. Wymień każdy krok, aby rozpocząć. Następnie postaraj się wykonać to zadanie, ściśle przestrzegając kroków podanych w podanej kolejności. Przeglądając pierwotną listę, jest możliwe, a może nawet prawdopodobne, że znajdziesz jakieś stagktórych brakuje. Ponadto może się okazać, że coś, co kiedyś uważałeś za jedno zadanie, w rzeczywistości musi zostać podzielone na kilka czynności ze względu na przejrzystość.
Przed przejściem do następnej fazy pisania podręcznika użytkownika upewnij się, że określiłeś jasny wynik dla każdego kolejnego kroku, który przydzieliłeś. Przed przejściem do następnego poziomu czytelnicy powinni mieć całkowitą jasność co do tego, co chcą osiągnąć i jak to powinno wyglądać. - Mapuj podróż użytkownika
Zrozumienie, w jaki sposób Twoi konsumenci planują korzystać z Twojego produktu i ułatwienie im tego, to cele stworzenia przewodnika użytkownika. Musisz włożyć wysiłek, aby zrozumieć problem, który konsument próbuje rozwiązać lub cel, który próbuje osiągnąć, korzystając z Twojego rozwiązania, a także sposób, w jaki angażuje się w Twoją firmę. Możesz zaplanować kroki niezbędne do przeprowadzenia klienta przez ten proces, wykorzystując te szczegóły do wizualizacji jego podróży od problemu do rozwiązania. - Wybierz szablon
Zadanie pisania i opracowywania instrukcji obsługi można znacznie uprościć, niż można by się spodziewać, tworząc serię szablonów. Twoja procedura może zostać usprawniona, a spójność stanie się znacznie bardziej realistycznym celem.
W szablonie instrukcji użytkownika, oprócz określenia szczegółów, takich jak czcionki (rodzaj i rozmiar), wymagania dotyczące kontrastu i schematy kolorów, należy również uwzględnić następujące elementy:- Powierzchnia przeznaczona na wprowadzenie
- Wyraźne podsekcje i sekcje
- Wybrany przez Ciebie format przekazywania serii działań
- Przestrogi i ostrzeżenia
- Powierzchnia przeznaczona na zakończenie
- Pisz proste i łatwe do zrozumienia treści
Materiał zawarty w instrukcji obsługi powinien być tak prosty i zrozumiały, jak to tylko możliwe. Ważne jest, aby przemyśleć i przeanalizować format i treść dla przejrzystości i wygody.
Upewnij się, że każda faza procesu przedstawia tylko jedno zadanie i używa możliwie jasnego i krótkiego języka. Upewnij się, że odpowiednio modyfikujesz swój tekst, aż będziesz mieć instrukcję obsługi zawierającą tylko te informacje, które są naprawdę niezbędne. - Podejdź do każdego użytkownika jak do nowicjusza
Załóżmy, że czytelnik Twojej instrukcji obsługi nie znał Twojego produktu podczas jego tworzenia. Pisz tak, jakbyś rozmawiał z laikiem.
Należy unikać używania żargonu lub języka technicznego. Oczywiście będą chwile, kiedy trzeba będzie tego unikać, ale to powinien być absolutny wyjątek. - Przetestuj instrukcje produktu z początkującymi użytkownikami
Faza testowania procesu tworzenia instrukcji obsługi jest kluczowa. Istotny wpływ na wynik ma przedmiot eksperymentu.
Najlepiej byłoby przeprowadzić testy na osobach, które nigdy nie używały Twojego produktu ani nie widziały dokumentacji. Podczas przeglądania instrukcji obsługi obserwuj ich, jak kończą proces i zapisuj, gdzie utknęli. Następnie należy odpowiednio zaktualizować informacje.
Tylko pomoc w instrukcji obsługi powinna być niezbędna dla twoich testerów do obsługi produktu. Nie powinni prosić o więcej pomocy. Przewodnik ZSRR powinien zawierać wszystkie wymagane informacje. - Twórz treści, stosując praktyczne podejście
Należy dołożyć wszelkich starań, aby oferować konkretne npamppliki i szczegółowe opisy wszelkich wyników, których mogą doświadczyć użytkownicy po wykonaniu każdego kroku w instrukcji obsługi. Użytkownik powinien być świadomy wszelkich informacji zwrotnych, jakie może otrzymać od produktu, a także wszelkich potencjalnych widoków lub dźwięków, które może napotkać po drodze. - Wcześnie wyjaśniaj symbole, ikony i kody
Podczas pisania instrukcji obsługi może być konieczne zastosowanie ikon, symboli lub kodów, aby zapewnić niezbędne instrukcje. Aby uniknąć dezorientacji lub frustracji czytelnika, bardzo ważne jest, aby zidentyfikować je jak najwcześniej w instrukcji obsługi.
Często zadawane pytania dotyczące instrukcji obsługi
Czym dokładnie są instrukcje obsługi?
Dokumentacja użytkownika to informacje dostarczane w formie instrukcji obsługi lub przewodników użytkownika, które mają pomóc użytkownikom końcowym w udanej interakcji z produktem.
- Jakie rodzaje dokumentacji użytkownika są dostępne?
Dokumentacja fizyczna, taka jak broszury lub instrukcje, była tradycyjnie wykorzystywana do oferowania dokumentacji użytkownika. Obecnie instrukcje obsługi są częściej tworzone i dystrybuowane w formie cyfrowej. - Co zawiera instrukcja obsługi?
W instrukcji obsługi lub podręczniku użytkownika zastosowano dobry projekt, jasne pismo i skupienie się na rozwiązywaniu problemów. Muszę mieć spis treści, przestrzegać logicznej hierarchii i przepływu oraz oferować przystępną treść. Dodatkowo, dobra instrukcja obsługi będzie możliwa do przeszukiwania i będzie uwzględniać potrzeby użytkownikaviews. - Jak powstaje dokument użytkownika?
Do opracowania instrukcji obsługi można zastosować proste kroki. Najpierw należy określić cele podręcznika użytkownika i opracować strategię ich realizacji. Instrukcja obsługi musi zostać przetestowana iw razie potrzeby zaktualizowana przed opublikowaniem. Na koniec ważne jest, aby podręcznik użytkownika był aktualizowany, wprowadzając zmiany w miarę dodawania nowych aktualizacji lub wydań.