podręcznik użytkownika lub Podręcznik użytkownika to dokument komunikacji technicznej, który ma na celu edukowanie użytkowników na temat konkretnego produktu. Produkowane w druku lub cyfrowo, mogą być pisane o prawie każdym produkcie, ale są najczęściej związane z oprogramowaniem i sprzętem komputerowym, urządzeniami elektronicznymi i grami wideo.
zwykle pisane przez pisarzy technicznych lub projektantów produktów, jego celem jest informowanie użytkowników i pomoc im w rozwiązywaniu wszelkich problemów dotyczących produktu. Jako istotny element dystrybucji produktów, jakość instrukcji obsługi może mieć duży wpływ na ogólne wrażenia klientów, dlatego chcesz ją dobrze wykonać!
w tym artykule podzielę się wskazówkami, jak napisać instrukcję obsługi, która wyraźnie przekazuje informacje klientom i pokażę, jak zorganizować proces pisania w Zenkit.
Wskazówki dotyczące pisania instrukcji obsługi
wiele się składa na pisanie instrukcji obsługi. Od opisów funkcji, przez instrukcje napraw, po wszystkie szczegóły prawne i ostrzeżenia dotyczące bezpieczeństwa. Oto kilka wskazówek, o których należy pamiętać, jeśli chodzi o pisanie:
- Poznaj swój cel
każda instrukcja obsługi powinna mieć swój cel. Zwykle ma pomóc użytkownikom rozwiązać problemy dotyczące Twojego produktu, ale dzięki temu powinieneś również zdecydować, w jaki sposób chcesz im pomóc. Gdy już zdecydujesz się na kąt, który chcesz wziąć, podziel informacje na sekcje i instrukcje krok po kroku, które są wystarczająco proste do naśladowania.
- Określ użytkownika
konieczne jest poznanie rodzaju odbiorców, którzy przeczytają instrukcję użytkownika, ponieważ wpłynie to na sposób jej pisania. Znajomość przeciętnego użytkownika może dać ci wyobrażenie o języku, którego powinieneś używać podczas pisania instrukcji, formacie i ogólnym stylu. Na przykład pisanie dla doświadczonych technologicznie specjalistów IT będzie bardzo różne od pisania dla rodziców z młodymi rodzinami.
- użyj dostępnego języka
niezależnie od tego, kim są Twoi odbiorcy, język tekstu instrukcji obsługi powinien być dostępny nawet dla osób najbardziej nietechnicznych. Musisz założyć, że czytelnik nie ma żadnej wiedzy na temat Twojego produktu, więc powinien być zrozumiały, jasny i zwięzły. Powinien adresować się do czytelnika, a stosowanie żargonu powinno być ograniczone.
- zrób to wizualnie
ludzie są znani z przetwarzania danych wizualnych 60 000 razy szybciej niż tekst, dlatego chcesz, aby Twoja Instrukcja obsługi zawierała obrazy. Podręczniki użytkownika prawie zawsze zawierają odpowiednie obrazy z tekstem. Niektóre produkty udostępniają nawet obrazy zrzutów ekranu z instrukcjami krok po kroku lub są tylko obrazami (podręczniki IKEA są znane bez tekstu). Obrazy mogą naprawdę pomóc przekazać wiadomość, którą chcesz przekazać czytelnikowi.
- zwiększ łatwość wyszukiwania
Spójrzmy prawdzie w oczy, nikt nie przeczyta całej instrukcji użytkownika, więc aby czytelnicy mogli znaleźć w niej wartość, musisz ją uprościć, aby ludzie mogli przejrzeć i znaleźć to, czego szukają. Nadaj mu czysty format, mając spójny układ od strony do strony i upewnij się, że między kawałkami tekstu jest dużo miejsca. Użyj znanych słów kluczowych związanych z produktem i upewnij się, że czcionka jest prosta i czytelna.
jak zaplanować instrukcję obsługi
Zenkit to świetne narzędzie do planowania instrukcji obsługi. Narzędzie do zarządzania projektami jest wyposażone w funkcje, które umożliwiają zbieranie danych, a następnie strukturyzowanie ich w celu stworzenia zoptymalizowanego przepływu pracy. Oto kroki, aby zorganizować proces pisania instrukcji użytkownika.
Krok 1:
Załóż darmowe konto Zenkit i zaloguj się.
Krok 2:
po dostosowaniu profilu kliknij „nowa kolekcja”, nadaj swojej kolekcji nazwę i naciśnij enter lub „utwórz”. Zostaniesz przekierowany do domyślnego widoku Kanban.
możesz nadać swojej kolekcji odrobinę charakteru, dostosowując do niej ikonę. Aby to zrobić, kliknij tytuł kolekcji, wybierz „Personalizacja”i wybierz kolory i logo ikony, które chcesz.
osobiście jestem fanem używania tablicy Kanban do wizualnego mapowania planu projektu. Wizualny system planowania doskonale nadaje się do identyfikacji wąskich gardeł i problemów, które mogą pojawić się podczas procesu planowania. Może również dać ci krystalicznie czysty przegląd postępów twojego projektu.
Widok Kanban przedstawia trzy domyślne kolumny oznaczone jako „To-Do, In Progress, and Done”. Możesz zmienić nazwy kolumn, klikając jedną z nazw etykiet i przechodząc do sekcji nazwa w polu menu, które się pojawi. Aby dodać więcej etapów do przepływu pracy, wystarczy kliknąć „+ Dodaj etap”, nadać kolumnie etykietę i kliknąć” Utwórz ” lub nacisnąć enter.
oczywiście możesz wybrać dowolną liczbę etapów dla swojego przepływu pracy i oznaczyć je według własnego uznania. Etapy, na które poszedłem, są następujące:
- Info & zasoby
- opinie & instrukcje
- sekcje
- projekty
Krok 3:
po ustaleniu struktury przepływu pracy możesz rozpocząć dodawanie innych elementów jako elementów pod każdą kolumną.
jak wspomniałem na początku tego artykułu, projekt taki jak napisanie instrukcji obsługi zawiera wiele treści; treści, które należy podzielić na różne rozdziały i sekcje oraz sekcje sekcji.
podtytuły Zenkit to idealna funkcja do dzielenia większych zadań na mniejsze. Jedno z 12 niestandardowych pól naszego narzędzia do zarządzania projektami prezentuje wszystkie twoje elementy w uporządkowany sposób, dzięki czemu możesz pracować z łatwą do zarządzania osią czasu.
aby dodać subitem do jednego z elementów, po prostu kliknij na element, aby go otworzyć. Następnie kliknij znak”+”, który znajduje się nad sekcją komentarzy, a następnie wybierz „pole niestandardowe”. W sekcji” Typ ” przewiń w dół i wybierz pole „subitems”. Nie zapomnij nadać polu nazwy!
Krok 4:
aby dodać kolejną strukturę do obiegu pracy, możesz użyć widoku hierarchii Zenkit. Aby aktywować ten widok w swojej kolekcji, kliknij „Kanban” (lub nazwę dowolnego widoku, w którym się znajdujesz), który znajdziesz w prawym górnym rogu i wybierz „nowy widok”. Rozszerzenie menu powinno pojawić się i po prostu wybrać „hierarchia”.
Krok 5:
gdy po raz pierwszy użyjesz widoku hierarchii, zobaczysz, że twoje elementy nie są połączone. Możesz je połączyć, przeciągając i upuszczając każdy element na główny panel hierarchii. Jeśli przeciągniesz element nadrzędny, okaże się, że subitems pojawi się wraz z nim.
hierarchia przypisana do elementu zależy od tego, gdzie go umieścisz. Na przykład, elementy przeciągnięte na górę będą miały hierarchię pierwszego poziomu, a elementy przeciągnięte pod innym zamienią się w poditem tego elementu.
widok hierarchii pokazuje każdy element dodany do hierarchii elementów za pomocą wcięć, aby wskazać, kiedy element staje się subitem. Możesz uzyskać przegląd najważniejszych zadań lub zobaczyć wszystko w projekcie jednocześnie, zwijając lub otwierając elementy.
planowanie innych rodzajów dokumentów tekstowych i materiałów
podobnie jak planowanie instrukcji obsługi, Zenkit może być używany do planowania innych dokumentów lub materiałów o dużej zawartości tekstu. Widok hierarchii i funkcja subitem są idealne do planowania każdego projektu, który wymaga zorganizowania dużej ilości treści, które należy podzielić na różne sekcje, takie jak powieść lub praca dyplomowa.
plan pisania powieści
pisanie powieści może potrwać lata, dlatego dobrze jest mieć gdzieś, gdzie można to wszystko zanotować. Korzystając z szablonu podobnego do podręcznika użytkownika, możesz uporządkować rozdział powieści po rozdziale i śledzić wszystkie szczegóły postaci, fabuły i tematu na jednej platformie.
plan pracy dyplomowej
od pomysłów tematycznych do badań po zbieranie danych, pisanie pracy dyplomowej lub dysertacji wymaga dużo planowania. Korzystając z Zenkit do zarządzania tym wszystkim, może pomóc ci w przygotowaniu pracy dyplomowej na czas i upewnić się, że nie przeoczysz czegoś ważnego!
Kliknij tutaj, aby skorzystać z naszego szablonu planowania pracy dyplomowej.
świetna Instrukcja obsługi wyraźnie przekazuje informacje czytelnikowi, dzięki czemu są w stanie przezwyciężyć wszelkie problemy, które mogą pojawić się z produktem. Korzystanie z Zenkit do planowania procesu pisania oraz korzystanie z widoku hierarchii i funkcji subitem może pomóc w stworzeniu wysokiej jakości instrukcji obsługi, która zapewni Twoim klientom najlepsze możliwe wrażenia.
która Instrukcja obsługi była dla ciebie pomocna?
Cheers,
Dinnie i zespół Zenkit