Zawartość

• Do kroku
• Część 1 z 4: Planowanie instrukcji obsługi
• Część 2 z 4: Osadź istotne informacje
• Część 3 z 4: Opis konserwacji produktu
• Część 4 z 4: Napisz czytelną instrukcję
• Porady

Oprogramowanie, komputery, gry i urządzenia wymagają podręczników użytkownika; poradniki wyjaśniające, jak używać produktu (i jak tego nie robić). Instrukcja obsługi jest dokumentem formalnym o określonej strukturze i musi być napisana przez osobę, która zna produkt od podszewki, na przykład pisarza technicznego lub projektanta produktu. Pisanie skutecznej instrukcji obsługi wymaga wiedzy, kto będzie korzystał z produktu, i napisania instrukcji z myślą o tych użytkownikach. Pisanie powinno być jasne, precyzyjne i proste, aby zapewnić bezproblemową obsługę.

Do kroku

Część 1 z 4: Planowanie instrukcji obsługi

1. Przeprowadź analizę użytkownika. Instrukcja obsługi powinna być napisana z myślą o użytkownikach - tych, którzy kupią Twój produkt lub usługę i zapoznają się z instrukcją obsługi. Analiza użytkowników powie Ci, kim będą Twoi główni lub docelowi odbiorcy i poprowadzi Cię przez proces pisania tekstu.
   • Porozmawiaj z osobami, które będą używać Twojego urządzenia. Oferuj użytkownikom testowym prototypy urządzenia i szkic instrukcji obsługi w kontrolowanych warunkach. Poproś użytkowników testowych o opinie na temat niejasnych lub niejasnych elementów w podręczniku użytkownika i dokonaj zmian w podręczniku użytkownika na podstawie tych opinii.
   • Nigdy nie możesz zadowolić całej swojej publiczności; napisz instrukcję dostosowaną do grupy docelowej lub największej grupy odbiorców.
   • Weź pod uwagę wiek, stan zdrowia (czy mają jakieś choroby, trudności w uczeniu się lub niepełnosprawności?) Oraz poziom wykształcenia słuchaczy, aby określić najlepsze podejście do pisania instrukcji obsługi.
2. Skoordynuj projekt instrukcji obsługi. Jeśli byłeś częścią zespołu, który pomógł zaprojektować i rozwinąć urządzenie lub produkt, obiektywne spojrzenie na produkt i wyjaśnienie jego działania może być trudne. Dlatego powinieneś zasięgnąć porady pisarza (najlepiej kogoś z doświadczeniem w pisaniu instrukcji) i grafika, którzy pomogą ci przygotować instrukcję obsługi. Możesz wybrać te osoby poprzez zewnętrzne doradztwo lub z własnej firmy lub organizacji.
3. Wykonaj analizę zadania. Analiza pracy to proces identyfikacji i organizacji czynności niezbędnych do korzystania z urządzenia. Dokładna analiza pracy identyfikuje materiały i sprzęt (takie jak baterie, leki lub inne produkty dostarczone przez użytkownika) wymagane na każdym etapie, a także działania, błędy i porady dotyczące rozwiązywania problemów, których może wymagać każdy krok.
   • Jeśli masz produkt, który może wykonywać wiele różnych zadań lub podzadań, musisz wykonać analizę zadania dla każdego zadania. Na przykład: w samochodzie możesz trąbić, zapiąć pasy i włączać lub wyłączać reflektory. W razie potrzeby przeprowadź analizę pracy dla każdego z nich.
4. Upewnij się, że Twój produkt spełnia wymagania dotyczące oznakowania i pozwolenia na dopuszczenie do obrotu. Wymagania te zapewniają, że produkty są wytwarzane z myślą o bezpieczeństwie użytkownika, a narażenie użytkownika na niebezpieczne warunki, takie jak promieniowanie i porażenie prądem elektrycznym, jest ograniczone. Reklamy powinny jasno określać cel i podstawowe wytyczne dotyczące obsługi produktu. Z tych zasobów należy korzystać podczas pisania instrukcji obsługi.
   • Aby instrukcja obsługi produktu była skuteczna, musi być napisana zgodnie z etykietami umieszczonymi bezpośrednio na produkcie.
   • Przed napisaniem instrukcji obsługi upewnij się, że Twoje urządzenie jest oficjalnie licencjonowane do sprzedaży.
5. Wybierz układ swojej instrukcji. Istnieje kilka ważnych sposobów na usprawnienie instrukcji. Na początku każdej sekcji należy umieścić pogrubiony nagłówek, aby każde słowo było pisane dużymi literami. Na przykład nagłówki sekcji „Skonfiguruj urządzenie”, „Obsługuj urządzenie” i „Rozwiązywanie problemów” mogą być pogrubione.
   • Innym sposobem usprawnienia przewodnika jest użycie dwóch kolumn, jednej po prawej stronie z tekstem, a drugiej tuż po lewej stronie tekstu, z punktorami, liczbami lub małymi ikonami, takimi jak znaki ostrzegawcze lub czerwone wykrzykniki.
   • Instrukcja może składać się głównie z obrazów z tekstem pod każdym obrazem w celu objaśnienia urządzenia lub może to być głównie tekst z kilkoma towarzyszącymi obrazami. Możesz również użyć schematu blokowego, aby poprowadzić użytkownika. Pomyśl o swoim produkcie io tym, jak każda metoda może pomóc w napisaniu instrukcji. Należy jednak unikać mieszania różnych układów w jednej instrukcji. Wybierz jeden i trzymaj się go.

Część 2 z 4: Osadź istotne informacje

1. Zorganizuj podręcznik w sposób logiczny. Instrukcja powinna być skonstruowana w taki sposób, aby użytkownik odniósł z niej jak najwięcej korzyści. Podziel instrukcję na rozdziały lub sekcje, które mają sens przy korzystaniu z produktu, i dołącz spis treści na początku instrukcji, tak aby można było szybko znaleźć każdą sekcję.
   • Spis treści jest szczególnie potrzebny w przypadku dłuższych podręczników.
   • Glosariusz lub indeks jest niezbędny, jeśli istnieje wiele terminów wyjaśniających, których Twoi odbiorcy mogą nie znać. Jednak glosariusz nie jest zalecany; najlepszym wyborem jest wyjaśnienie niejasnych terminów w samym tekście podręcznika. Jeśli zdecydujesz się dołączyć słownik, umieść go na początku instrukcji, zaraz po spisie treści.
   • Lista tabel lub rycin jest konieczna tylko wtedy, gdy w podręczniku jest więcej niż kilka tabel lub rycin.
   • Dodatek jest potrzebny dla rzeczy, które wymagają wyjaśnienia, ale nie mogą być wyjaśnione w innym miejscu podręcznika, ponieważ zakłóciłoby to przepływ i skupienie.
2. Uwzględnij niezbędne ostrzeżenia. Ogólne ostrzeżenia lub informacje o środkach ostrożności powinny zawierać informacje o potencjalnych zagrożeniach spowodowanych niewłaściwym użytkowaniem produktu, w tym o śmierci lub poważnych obrażeniach. Ostrzeżenia te należy umieścić na samym początku instrukcji, po pierwszej stronie, tak, aby użytkownik zobaczył je jako pierwszy. Konkretne ostrzeżenia powinny być również zawarte w tekście podręcznika tuż po lub tuż przed zasugerowaniem potencjalnie niebezpiecznego kroku.
   • Na przykład ogólne ostrzeżenie dla urządzenia elektrycznego może brzmieć, aby nie używać go podczas deszczu.
   • Konkretną instrukcją może być upewnienie się, że obie ręce i urządzenie są suche przed podłączeniem urządzenia do gniazdka elektrycznego.
   • Zapewnij obrazy (takie jak czaszka i skrzyżowane piszczele) lub tekst w innym kolorze (na przykład czerwony tekst), aby odróżnić ostrzeżenie od pozostałych wskazówek w instrukcji obsługi i zwrócić na nie uwagę użytkowników.
3. Opisz urządzenie. Twój opis powinien zawierać zarówno pisemne wyjaśnienie przeznaczenia urządzenia, jak i małą graficzną reprezentację tego, jak urządzenie wygląda. Rysunek powinien zawierać opisy i nazwy wszystkich przełączników, przycisków i dołączanych części znajdujących się w urządzeniu.
4. Zapewnij instrukcje instalacji. Sekcja instalacyjna powinna zawierać podstawowe informacje o tym, jak przygotować się do użytkowania produktu lub urządzenia. Jeśli urządzenie nie może być zbudowane lub ustawione przez użytkownika domowego, należy to wyraźnie zaznaczyć pogrubionym nagłówkiem u góry sekcji dotyczącej instalacji. Powinieneś również dołączyć następujące informacje:
   • Lista części
   • Instrukcje dotyczące rozpakowywania
   • Ostrzeżenia dotyczące instalacji
   • Konsekwencje nieprawidłowej instalacji
   • Do kogo zadzwonić w przypadku trudności podczas instalacji
5. Podaj informacje o operacji. Ta sekcja jest najważniejszą częścią instrukcji obsługi i powinna zawierać konkretne, szczegółowe informacje na temat korzystania z urządzenia. Rozpocznij od podstawowych przygotowań do korzystania z urządzenia, takich jak podłączenie przewodu zasilającego lub umycie rąk. Kontynuuj, wykonując logiczne, ponumerowane kroki opisujące sposób korzystania z urządzenia, a także wszelkie informacje zwrotne (na przykład „Usłyszysz kliknięcie ...”), których użytkownik może się spodziewać podczas prawidłowego korzystania z urządzenia.
   • Na końcu tego rozdziału użytkownicy powinni zapoznać się z rozdziałem dotyczącym rozwiązywania problemów, aby rozwiązać problemy, których nie można szybko wyjaśnić.
   • W razie potrzeby umieść obrazy. Niektóre kroki najlepiej wyjaśnić zarówno obrazami, jak i słowami. Rozważ użycie zdjęć lub ilustracji w podręczniku.
   • W tej sekcji, podobnie jak w każdej innej sekcji, należy zamieścić odpowiednie ostrzeżenia dotyczące nieprawidłowego użytkowania lub obsługi. Na przykład możesz ostrzec użytkowników piły łańcuchowej, aby nie pili alkoholu ani nie używali piły łańcuchowej podczas przyjmowania niektórych leków.
   • Jeśli uważasz, że użytkownicy odniosą korzyści, rozważ dołączenie linków do filmów online demonstrujących prawidłowe użytkowanie i działanie urządzenia. Możesz nagrać te filmy na początku tej sekcji lub (w przypadku filmów, które przedstawiają tylko jeden krok) na końcu każdego kroku.
6. Dołącz podsumowanie produktu na końcu. Podsumowanie powinno pojawić się na końcu instrukcji, tuż przed indeksem, aby zapewnić podstawowe czynności operacyjne. Powinna to być uproszczona, okrojona wersja informacji operacyjnych i nie powinna zajmować więcej niż jedną stronę. Podsumuj, w jaki sposób urządzenie lub produkt ma być używane. Uwzględnij podstawowe alerty, ponumerowane kroki wyjaśniające, jak korzystać z produktu, a także numery telefonów lub adresy e-mail, które kierują użytkowników do pomocy.
   • Jeśli spodziewasz się, że użytkownik będzie często usuwać arkusz podsumowania lub odwoływać się do niego, możesz wydrukować go na wyjmowanej karcie laminowanej lub grubym kartonie, aby ułatwić użytkownikowi przenoszenie i odwoływanie się.
   • Alternatywnie możesz zastosować podsumowanie bezpośrednio do produktu, aby użytkownik mógł się z nim szybko zapoznać.

Część 3 z 4: Opis konserwacji produktu

1. Wyjaśnij, jak czyścić urządzenie. Jeśli urządzenie lub produkt wymaga czyszczenia, wyjaśnij, jak to zrobić. Wymień wymagane środki czyszczące. Powiedz czytelnikowi, jak często czyścić. Następnie, podobnie jak w każdej innej części instrukcji, dołącz ponumerowane instrukcje krok po kroku, jak ją wyczyścić.
   • Jeśli czyszczenie wymaga rozmontowania produktu lub usunięcia określonej części lub części, należy wskazać, w jaki sposób produkt powinien zostać rozmontowany.
   • Ostrzegaj o skutkach braku czyszczenia urządzenia. Na przykład możesz powiedzieć: „Jeśli urządzenie nie zostanie wyczyszczone, wydajność będzie niższa od optymalnej”.
2. Policz użytkownika, jak wykonać podstawową konserwację. Jeśli produkt lub urządzenie jest przystosowane do naprawy przez użytkownika, aby rozwiązać problemy z wydajnością, należy podać numerowane instrukcje, jak to zrobić dla użytkownika. Na przykład, jeśli baterie wymagają wymiany po każdych 300 godzinach użytkowania, podaj instrukcje, jak sprawdzić, czy baterie wymagają wymiany, jak wyjąć zużyte baterie i jak zainstalować nowe.
   • Jeśli istnieją pewne czynności konserwacyjne, które mogą być wykonywane tylko przez certyfikowanego technika, należy podzielić część instrukcji dotyczącą konserwacji na dwie części.
3. Omów opcje przechowywania. W razie potrzeby instrukcja powinna wyjaśniać, jak prawidłowo przechowywać produkt lub urządzenie. należy również zamieścić informacje o tym, dlaczego przechowywanie jest konieczne i jakie są konsekwencje niewłaściwego przechowywania. Na przykład: możesz napisać:
   • Produkt przechowywać w chłodnym, suchym miejscu. Niewłaściwe przechowywanie może skrócić żywotność produktu ze względu na gromadzenie się wilgoci ”.
   • „Nie wystawiać produktu na działanie ciepła ani nie przechowywać go w temperaturze powyżej 50 stopni Celsjusza.Jeśli to zrobisz, może to doprowadzić do zapalenia ”.
4. Podaj informacje dotyczące rozwiązywania problemów. Możesz zorganizować tę sekcję jako listę typowych problemów i ich rozwiązań. Pogrupuj podobne problemy pod logicznym nagłówkiem. W ten sposób użytkownicy mogą szybko znaleźć określone problemy.
   • Na przykład, jeśli występuje kilka problemów z wyświetlaniem niebieskiego ekranu przez komputer, pogrupuj je w ramach podtytułu, takiego jak „Typowe problemy z ekranem”.
   • W tej sekcji musisz również podać numer telefonu i / lub adres e-mail do obsługi klienta.

Część 4 z 4: Napisz czytelną instrukcję

1. Przeczytaj inne instrukcje obsługi. Przed napisaniem instrukcji dla własnego produktu zapoznaj się z innymi skutecznymi instrukcjami obsługi. Zwróć uwagę na strukturę, dobór słów i strukturę zdań. Główne marki, takie jak Apple, Google i Microsoft, opracowują solidne, skuteczne podręczniki użytkownika, które mogą pomóc w stworzeniu bardziej przemyślanego podręcznika użytkownika.
   • Nie tylko czytaj wszystko podręczniki użytkownika. Przeczytaj instrukcje obsługi podobnych produktów, które sprzedajesz. Na przykład, jeśli sprzedajesz produkty dla dzieci, czytaj instrukcje dla dzieci, a nie techniczne.
2. Wybierz swoje standardy. Ujednolicenie pisowni, doboru słów i sformułowań sprawi, że podręcznik użytkownika będzie bardziej przyjazny dla użytkownika. Chicago Manual of Style i Microsoft Manual of Style mogą być również pomocnymi przewodnikami stylistycznymi podczas pisania podręcznika użytkownika; sprawdź oba, aby sprawdzić, czy jeden jest odpowiedni dla twojej instrukcji.
   • Na przykład zamiast używać w instrukcji zarówno „wyłącznika”, jak i „przycisku zasilania”, wybierz jeden z dwóch terminów i trzymaj się go.
3. Użyj aktywnego głosu. Głos aktywny to sposób pisania, który wyjaśnia rzeczy z perspektywy użytkownika. Łatwiej jest zrozumieć niż alternatywę, głos bierny, w którym temat jest nieokreślony.
   • Wypróbuj aplikację Hemingway (www.hemmingwayapp.com), aby zidentyfikować pasywne fragmenty w swoim piśmie.
   • Przestudiuj te dwa przykładowe zdania - pierwsze jest aktywne, a drugie pasywne:
     • Musisz powoli i ostrożnie otwierać paczkę.
     • Opakowanie należy otwierać powoli i ostrożnie.
4. Napisz ponumerowane instrukcje. Instrukcje uporządkowane numerycznie pomagają czytelnikowi lepiej skupić się na procesie użytkowania, łączenia lub budowania danego produktu. Zamiast pisać długi, szczegółowy akapit lub serię nienumerowanych akapitów, napisz swój podręcznik użytkownika z prostymi, wyraźnymi krokami, każdy wyraźnie ponumerowany.
5. Rozpocznij każdy krok od imperatywu. Imperatyw to czasownik zorientowany na działanie. Rozpoczynając każdy krok czasownikiem, dajesz czytelnikowi wskazówkę dotyczącą czynności wymaganej do ukończenia kroku. Na przykład, w zależności od produktu, o którym piszesz, możesz rozpocząć swoje kroki poleceniem typu „Połącz”, „Potwierdź” lub „Slajd”. Nie rozpoczynaj jednak swoich kroków od odpowiedzi z systemu.
   • Na przykład, jeśli ekran zmieni kolor na niebieski i zacznie migać, nie rozpoczynaj tego kroku od: „Ekran zacznie migać i zmieni kolor na niebieski.” Spróbuj: ”Naciśnij i przytrzymaj klawisz ekranu głównego. Ekran zacznie migać i zmieni kolor na niebieski ”.
6. Określ, jakiego słownictwa będziesz używać. Jeśli piszesz podręcznik jo-jo, Twoimi odbiorcami będą głównie małe dzieci. Użyj prostych słów i słownictwa, aby wyjaśnić, jak działa jo-jo. Kiedy piszesz podręcznik do skaningowego mikroskopu elektronowego, twoją publiczność stanowią wysoko wykwalifikowani naukowcy, którzy potrafią zrozumieć bardzo szczegółowe informacje, więc nie wahaj się używać specjalistycznego słownictwa lub skomplikowanych wyjaśnień.
   • Ogólnie starasz się unikać żargonu i technicznego języka.
   • Aby być efektywnym dla jak największej liczby użytkowników, staraj się pisać na poziomie od szóstej do siódmej klasy szkoły podstawowej.
7. Wysyłając produkt za granicę, upewnij się, że tłumaczenia są dokładne. Zatrudnij tłumacza, który przetłumaczy Twoją instrukcję obsługi na język ojczysty kraju, do którego wysyłasz produkt. Możesz także skorzystać z programu do tłumaczenia online, ale poproś native speakera o przeczytanie tłumaczenia i sprawdzenie, czy nie ma błędów.
   • Jeśli wśród Twoich odbiorców reprezentowanych jest wiele grup językowych, dołącz tłumaczenia instrukcji obsługi na każdy odpowiedni język.
   • Tłumacz musi znać produkt, ponieważ w języku docelowym mogą występować różne słowa dla określonych terminów, które nie są tłumaczeniami słowo w słowo.
8. Pisz krótkimi zdaniami. Zamiast kilku długich akapitów, używasz wielu krótkich akapitów. Poszukaj logicznych podziałów w każdej sekcji i streść przydatne informacje w jedno- lub dwuzdaniowych fragmentach. To samo dotyczy poziomu zdania. Zdania powinny być krótkie i proste, a nie długie i szczegółowe.
   • Jeśli krok staje się zbyt długi, podziel go na mniejsze kroki. Nie zmniejszy to liczby słów, ale podziały wierszy ułatwią czytanie.
9. Sprawdź instrukcję pod kątem błędów. Podręcznik może stracić wiarygodność z powodu błędów gramatycznych i ortograficznych. Poproś współpracownika lub autora technicznego o edycję i korektę instrukcji. Oprócz ortografii i gramatyki korektor powinien zwrócić uwagę na następujące kwestie:
   • Strona bierna
   • Niejasny lub zagmatwany język
   • Opakowana struktura zdania
   • Zbyt długie akapity

Porady

• Ludzie uczą się na różne sposoby; Jeśli to możliwe i stosowne, dołącz pomoce wizualne lub linki do filmów online w podręczniku, aby dostosować je do czytelników zorientowanych na wzrok.