Krok 1 zdobywanie ogólnej wiedzy na temat szablonu instrukcji użytkownika

przed użyciem szablonu instrukcji użytkownika i innych narzędzi, które opracowałem dla Philipa, chciałem się upewnić, że mamy ten sam punkt wyjścia. Podałem mu kilka ogólnych informacji na temat instrukcji użytkownika i kilka dobrych przykładów istniejących podręczników użytkownika.

poniżej wymieniłem te informacje.,

Jaka jest definicja instrukcji obsługi?

Instrukcja obsługi jest technicznym dokumentem komunikacyjnym, którego celem jest pomoc ludziom w zakresie korzystania z produktu. Dobra instrukcja obsługi pomaga użytkownikom w bezpiecznym, zdrowym i skutecznym korzystaniu z produktu.,

Inne nazwy lub inne formy instrukcji obsługi mogą być:

  • Instrukcja obsługi
  • dokumentacja techniczna
  • Instrukcja obsługi
  • Instrukcja obsługi
  • Instrukcja obsługi
  • Instrukcja obsługi
  • Instrukcja obsługi
  • aby pomóc użytkownikowi), drugorzędnymi celami może być stworzenie lepszego doświadczenia użytkownika i spełnienie wymogów prawnych.

    podręcznik użytkownika składa się z tekstowych informacji wizualnych (ilustracje, zrzuty ekranu, tabele itp.,), aby pomóc użytkownikowi w wykonaniu określonych zadań.

    użytkownik odgrywa centralną rolę podczas sporządzania instrukcji obsługi. Dobrze opracowana Instrukcja obsługi zawiera tylko te informacje, które są istotne dla zamierzonego użytkownika produktu.

    podręcznik użytkownika powinien zawierać zarówno informacje proceduralne (instrukcje krok po kroku), jak i informacje koncepcyjne (informacje, których użytkownik potrzebuje, aby zrozumieć informacje proceduralne).

    dobra instrukcja obsługi jest zwięzła i używa języka wolnego od żargonu. Dobry podręcznik użytkownika powinien odpowiedzieć jak i jakie pytania., Powinny one zawierać informacje o tym, co się stanie, jeśli zadanie nie zostanie wykonane poprawnie.

    w niektórych przypadkach produkt jest przeznaczony do użytku przez różne typy użytkowników. Typowymi typami użytkowników są Użytkownik końcowy, instalator, inżynier utrzymania ruchu i operator. Każdy typ użytkownika wymaga innego podejścia pod względem używanego języka, tonu głosu i dostarczanych informacji koncepcyjnych.

    jakie informacje powinny znajdować się w instrukcji obsługi?

    różnego rodzaju produkty wymagają instrukcji obsługi. Produktem może być system, narzędzie, urządzenie, instrument, oprogramowanie lub aplikacja.,arnings

  • instrukcje instalacji
  • opis sposobu użytkowania/obsługi produktu
  • sekcja rozwiązywania problemów i instrukcje dotyczące rozwiązywania problemów
  • informacje dotyczące konserwacji
  • informacje dotyczące naprawy
  • informacje dotyczące usuwania produktu i opakowania
  • specyfikacje techniczne
  • tabela treści
  • indeks
  • Słowniczek
  • informacje dotyczące gwarancji

    • li>

  • dane kontaktowe

korzystanie z szablonu instrukcji obsługi

głównym narzędziem, które opracowałem, aby pomóc Filipowi w sporządzeniu instrukcji obsługi, jest szablon instrukcji obsługi., Szablon zawiera wszystkie informacje i Więcej z powyższej listy. Spełnia wymagania dla jego produktu.

szablon instrukcji obsługi może być użyty do utworzenia instrukcji obsługi systemu, narzędzia, Urządzenia, instrumentu lub do utworzenia instrukcji instalacji, instrukcji oprogramowania, instrukcji obsługi, instrukcji obsługi lub instrukcji szkolenia.

na podstawie pierwszego szablonu dla Philip opracowaliśmy szablony dla następujących grup produktów:

  • urządzenia medyczne
  • Zabawki
  • Maszyny
  • Elektronika

jakie formaty ma instrukcja obsługi?,

instrukcje obsługi mogą być dostarczane w formie papierowej lub jako dokument elektroniczny(PDF lub umieszczony online lub na urządzeniu w HTML). Szablon instrukcji obsługi to dokument MS Word, który można wydrukować lub umieścić online.

podręczniki użytkownika mogą być tworzone przy użyciu różnych narzędzi. Każde narzędzie ma swoje wady i zalety., możliwa zawartość

Indesign wysoki stopień swobody projektowania zmiany treści mogą wymagać wielu dodatkowych godzin DTP CMS (Technical authoring & publishing solutions) ponowne wykorzystanie treści
wszystko w jednym rozwiązaniu
Omni-publikacje na platformie
zawierają domyślne szablony instrukcji obsługi High learning curve

przykłady instrukcji obsługi

podczas tworzenia instrukcji obsługi za pomocą szablonu instrukcji obsługi może być przydatne kilka dobrych przykładów., Za pomocą poniższych linków możesz pobrać przykładową instrukcję obsługi do dokumentacji:

  • instrukcja instalacji IKEA
  • Instrukcja obsługi Jura

Krok 2 Zidentyfikuj użytkownika(Y) szablonu instrukcji obsługi

Ok, więc teraz Philip ma podstawową wiedzę na temat instrukcji obsługi. Zagłębimy się w szczegóły i działania.

Kiedy chcesz napisać podręcznik, który pomoże Ci rozwiązać problemy, najpierw musisz określić, kim jest Twój użytkownik. Można to zrobić poprzez utworzenie profilu użytkownika, również o nazwie persona.,

z persona, można dokonać pewnych rozsądnych założeń co do cech użytkownika. Jest to nie tylko przydatne do tworzenia instrukcji użytkownika, ale jest niezbędnym elementem na początku rozwoju każdego produktu! Jako wykształcony inżynier Wzornictwa Przemysłowego, tak rozpoczęliśmy wszystkie nasze zadania projektowe.

sprawdzając stronę ISOVOX, nie znalazłem nawet jasnego opisu ich zamierzonych użytkowników. Dlatego poprosiłem Filipa, aby zdefiniował swoich użytkowników i odpowiedział na pytania typu:

  • kto jest użytkownikiem Twojego produktu?,
  • czy produkt jest używany profesjonalnie czy głównie prywatnie?
  • jakie jeszcze mają doświadczenia techniczne? Co opisuje użytkownika?

stworzyłem szablon, który zawiera pytania. Poprosiłem Filipa o wypełnienie szablonu.

możesz użyć szablonu samodzielnie, aby określić, kim jest Twój użytkownik. Należy pamiętać, że druga zakładka zawiera również odpowiedzi Philipa, więc masz przykład, jak arkusz może być używany.

Akcja: użyj szablonu, aby opisać swoich użytkowników.

jestem wielkim fanem wizualizacji rzeczy., Więc jeśli chcesz zrobić krok dalej od zdefiniowania użytkownika, sugeruję wizualizację użytkownika w postaci persony. Tworząc persona nadajesz użytkownikowi imię, wiek itp., aby stał się on prawdziwą osobą reprezentującą użytkownika.

zrobiłem to dla Filipa., Oto wynik:

Akcja: Stwórz wizualizację swojego użytkownika

Jeśli chcesz dowiedzieć się więcej o definiowaniu odbiorców i tworzeniu person:

Krok 3 tworzenie tematów problemów Użytkownika

zacznij od zidentyfikowania problemów, które mogą napotkać użytkownicy podczas cyklu życia produktu i które chcą rozwiązać. Typowe problemy mogą obejmować: instalację produktu, korzystanie z produktu, bezpieczne użytkowanie produktu, konserwację produktu i utylizację produktu.,

Jeśli problem jest zbyt złożony, możesz go rozbić na kawałki.

poprosiłem Philipa o zidentyfikowanie problemów i rozwiązań, które jego użytkownik może napotkać podczas cyklu życia produktu. W tym celu stworzyłem kolejny szablon dla Filipa. W lewej kolumnie karty cyklu życia wymienione są etapy cyklu życia produktu. Są one zaczerpnięte z międzynarodowego standardu instrukcji użytkownika, IEC/IEEE 82079. Nasze szablony instrukcji obsługi są zgodne z tym standardem.

na karcie cyklu życia widać, jak Philip dostosował cykl życia do własnego produktu.,

działanie: użyj tego szablonu i instrukcji na pierwszej karcie, aby zidentyfikować problemy, które użytkownik może mieć podczas cyklu życia produktu i przedstawić swoje rozwiązania.,

Jeśli chcesz dowiedzieć się więcej o definiowaniu problemów użytkownika i tworzeniu tematów:

  • tworzenie stron tematycznych
  • minimalizm
  • mapowanie informacji
  • Chunking

Krok 4 Zdefiniuj strukturę szablonu instrukcji użytkownika

zidentyfikował problemy, które użytkownik może mieć ze swoim produktem w trakcie jego cyklu życia i teraz pomyślał o rozwiązaniu problemu. Innymi słowy: Filip zdefiniował tematy do swojej instrukcji obsługi., Każdy temat może dotyczyć tylko jednego konkretnego tematu, ma identyfikowalny cel i musi być w stanie być samodzielny.

temat powinien dać odpowiedź tylko na pytanie jednego użytkownika. Użytkownik chce rozwiązać jeden problem na raz. Gdy użytkownik rozwiąże problem, pójdzie i rozwiąże następny problem.

temat stanie się sekcją w instrukcji obsługi. Może to być rozdział lub (podpunkt)akapit. Gdy tylko użytkownik będzie szukał odpowiedzi na swój problem, użyje spisu treści, aby dowiedzieć się, jak przejść do tej odpowiedzi.,

poprosiłem Filipa o uporządkowanie tematów i określenie ich miejsca w instrukcji użytkownika, poprzez przypisanie określonego tematu do określonego rozdziału lub (podpunkt)akapitu. Wynik można zobaczyć w zakładce spis treści.

działanie: aby zdefiniować strukturę podręcznika użytkownika:

  1. Skopiuj zawartość z karty cyklu życia do karty spisu treści.
  2. na karcie spis treści zastąp nazwę produktu własną nazwą produktu.
  3. Dodaj kolumnę po lewej stronie. Nazwij to „sekcją”.
  4. jeśli ma to zastosowanie, Uporządkuj swoje sekcje logicznie.
  5. określ, które tematy staną się rozdziałami, dodając numery rozdziałów., Rozpocznij numerowanie preparat do stosowania z numerem 4. W następnym kroku dodamy kolejne rozdziały.
  6. określ, jakie tematy staną się akapitami, dodając numery sekcji.
  7. określ, jakie tematy staną się akapitami, dodając numery podsekcji.

stworzyłeś spis treści (ToC). Spis treści jest zarysem instrukcji użytkownika. Później dodamy więcej tematów / sekcji, takich jak wprowadzenie, informacje dotyczące bezpieczeństwa itp., więc nie martw się o dodanie tego teraz.,

Krok 5 Utwórz znaczące nagłówki

każdy temat w instrukcji użytkownika otrzymuje swój własny nagłówek. Nagłówki są (pod)tytułami, które poprzedzają rzeczywisty tekst. Pojawiają się one w ToC, dzięki czemu użytkownik może przejść do potrzebnych informacji.

Filip właśnie stworzył (pod)tytuły swoich tematów.

ponieważ wpisy ToC odgrywają tak ważną rolę w pomaganiu użytkownikowi w znalezieniu drogi, a aby pomóc mu pominąć to, co nie jest ważne, potrzebują trochę więcej uwagi.

zasadniczo powinieneś spróbować pracować z trzema poziomami nagłówków: nagłówkami pierwszego, drugiego i trzeciego poziomu.,

nagłówek pierwszego poziomu opisuje, o czym jest cały rozdział lub sekcja (np. instalacja produktu). Nagłówki drugiego poziomu powinny stosować styl frazowania „jak co” (np. Jak złożyć produkt i jak wykonać instalację elektryczną). Nagłówek trzeciego poziomu używa zwrotów rzeczownikowych (np. Zawartość opakowania i narzędzia do użycia).

poprosiłem Filipa o przekierowanie nagłówków i zwrócenie uwagi na następujące ogólne wytyczne:

  • użyj struktury jak pokazano powyżej dla nagłówków pierwszego, drugiego i trzeciego poziomu.,
  • upewnij się, że nagłówki są oczywiste. Nagłówek robiący naleśniki jest znacznie bardziej zorientowany na użytkownika niż korzystanie z MagicCook5000.
  • upewnij się, że nagłówek obejmuje cały temat. Jeśli sekcja obejmuje konserwację i naprawę produktu, Konserwacja pozycji byłaby niekompletna.
  • jeśli to możliwe, spróbuj pominąć artykuły na początku nagłówków

Akcja: napisz nowe nagłówki dla swoich wpisów spisu treści.

spis treści Philipsa ze znaczącymi nagłówkami można znaleźć w zakładce spis treści w. znaczące nagłówki.,

Krok 6 Określ treść prawną

w zależności od Rynku, na którym produkt jest wprowadzany do obrotu lub oddawany do użytku oraz w zależności od grupy produktów, do której należy produkt, do produktu mają zastosowanie szczególne przepisy.

ogólnie rzecz biorąc, przepisy wymagają, aby twój produkt był „bezpieczny”, a zatem określają ogólne wymagania bezpieczeństwa, które powinien spełniać Twój produkt.

wymagania te obejmują również wymagania dotyczące treści instrukcji obsługi i instrukcji bezpieczeństwa.,

aby sprzedać swój produkt na określonym rynku, należy upewnić się, że instrukcja obsługi jest zgodna z tymi wymaganiami.

w tych dwóch poniższych artykułach dowiesz się, w jaki sposób możesz dokładnie dowiedzieć się, które przepisy mają zastosowanie do Twojego produktu na rynek europejski i amerykański oraz jakie są wymagania dla Twojej instrukcji obsługi. Wskazówka dla profesjonalistów: gdy dostępna jest już deklaracja zgodności, można tam znaleźć odpowiednie dyrektywy.,

  • Jak tworzyć zgodne Podręczniki dla UE
  • Jak tworzyć zgodne Podręczniki dla USA

Philip nie musiał wykonywać tych kroków, ponieważ szablon, którego użył, zawierał już treść prawną wymaganą przez odpowiednie dyrektywy.

dla jego produktu oznacza to, że w instrukcji obsługi dla jego produktu wymagane są następujące informacje:

UE (odpowiednie dyrektywy w sprawie oznakowania CE: LVD, EMC, RoHS, WEEE, REACH):

  • Instrukcja obsługi powinna być przetłumaczona na język(języki) kraju, w którym produkt jest sprzedawany.,
  • Instrukcja obsługi powinna opisywać przeznaczenie produktu.
  • Instrukcja obsługi powinna opisywać racjonalnie przewidywane niezamierzone użycie produktu.
  • w stosownych przypadkach należy wspomnieć o niezgodności w obszarach mieszkalnych.
  • Typ, numer partii lub serii lub inny element umożliwiający identyfikację produktu powinien być wymieniony na produkcie. Jeśli produkt jest zbyt mały, można go umieścić w instrukcji obsługi.
  • nazwa, zarejestrowana nazwa handlowa lub zarejestrowany znak towarowy oraz adres pocztowy powinny być wymienione na produkcie., Jeśli produkt jest zbyt mały, można go umieścić w instrukcji obsługi.
  • należy przeprowadzić analizę ryzyka w celu określenia ryzyka resztkowego związanego ze stosowaniem produktu. Należy podać informacje dotyczące bezpieczeństwa w celu poinformowania Użytkownika o środkach, które należy podjąć.
  • informacje dotyczące WEEE należy uwzględnić
  • informacje dotyczące odpadów opakowaniowych należy uwzględnić.

oprócz tego prawodawstwa istnieje również międzynarodowy standard instrukcji obsługi, IEC/IEEE 82079-1: 2019. Norma ta została zharmonizowana w UE., Zgodność z normami zharmonizowanymi zapewnia domniemanie zgodności z odpowiednimi przepisami!

szablon instrukcji obsługi jest zgodny z tym standardem.

stworzyłem również listę kontrolną IEC 82079, która może być używana do podwójnego sprawdzenia, czy instrukcja obsługi jest zgodna z tym standardem.

aby stworzyć międzynarodową instrukcję obsługi, należy zawsze upewnić się, że instrukcja spełnia wymagania UE, USA i 80279.,

działanie: aby określić wymagania prawne zawarte w instrukcji obsługi:

  1. wykonaj kroki 1-2 z artykułów dotyczących zgodności w UE i / lub kroki 1-6 z artykułów dotyczących zgodności w USA, aby określić ramy prawne instrukcji.
  2. zapoznaj się z listą kontrolną IEC 82079, aby upewnić się, że instrukcja jest zgodna ze standardem 82079.

w tym filmie wyjaśniam, w jaki sposób można utworzyć instrukcję zgodną ze standardem 82079:

do sklepu

Krok 7 Pobierz i przygotuj szablon instrukcji obsługi

teraz Philip może rozpocząć rzeczywiste tworzenie instrukcji obsługi.,

poprosiłem go o dostosowanie spisu treści szablonu według własnego spisu treści. Bez usuwania i obowiązkowych elementów oczywiście…

pamiętasz z kroku 4, że prosiłem o rozpoczęcie numeracji odcinków od rozdziału 4? Po samodzielnym pobraniu szablonu instrukcji obsługi doc zobaczysz, że dodano kilka standardowych rozdziałów, a także niektóre dodatki.,

działanie: aby dostosować szablon instrukcji obsługi:

Jeśli chcesz pracować z darmowym szablonem:

  1. Pobierz darmowy szablon instrukcji obsługi Word 2013 lub 2007
  2. Zmień nagłówki sekcji zgodnie z własnym ToC. Uwaga! Nie dostosowuj spisu treści. Spis treści może być aktualizowany automatycznie po dostosowaniu nagłówków sekcji.
  3. Dodaj obowiązkową zawartość określoną w kroku 6 podręcznika.
  4. w stosownych przypadkach zmodyfikuj sekcje 1-3 i Dodatki zgodnie z własnymi potrzebami.,

lub użyj jednego z naszych płatnych szablonów, które zawierają wszystkie obowiązkowe treści, tak jak Philip:

  • urządzenia medyczne UE
  • urządzenia medyczne USA
  • maszyny UE
  • urządzenia elektroniczne UE
  • Zabawki UE

Krok 8 Utwórz zawartość szablonu podręcznika użytkownika

napisz zamierzone użycie

cel produktu, lub lepiej: przeznaczenie, jest sercem instrukcji obsługi i stanowi podstawę zapewnienia bezpiecznego i zdrowego użytkowania produktu.,

sposób, w jaki jest opisane przeznaczenie, określa również odpowiedzialność użytkownika i wpływa na dalszą treść instrukcji obsługi.

większość przepisów wymaga umieszczenia w instrukcji użytkownika opisu zamierzonego zastosowania.

międzynarodowy standard instrukcji dla użytkownika, IEC 82079-1, zawiera następującą definicję dla zamierzonego zastosowania:

wyczerpujący zakres funkcji lub przewidywanych zastosowań zdefiniowanych i zaprojektowanych przez dostawcę produktu

opisując zamierzone zastosowanie, określasz bezpieczną otoczkę produktu., A po określeniu zamierzonego zastosowania, możesz skupić się na dostarczaniu tylko tych instrukcji bezpieczeństwa i obsługi, jak korzystać z produktu w danej kopercie.

dodatkowo, do zamierzonego zastosowania, wiele innych norm, dyrektyw i rozporządzeń wymaga również podania opisu możliwego do przewidzenia niewłaściwego użycia.

na przykład, racjonalnie przewidywalnym niewłaściwym użyciem agresywnego detergentu może być użycie go w środowisku przetwarzania żywności.

zwracanie zbyt małej uwagi na opisanie racjonalnie przewidywalnego nadużycia wpłynie na odpowiedzialność firmy.,

przepisy dotyczące odpowiedzialności za produkt obciążają producenta odpowiedzialnością za wadliwy produkt. Jeśli wadliwość produktu musi zostać ustalona, wszystkie okoliczności zostaną wzięte pod uwagę. Obejmuje to racjonalnie przewidywalne wykorzystanie produktu.

opis zamierzonego zastosowania określa, które instrukcje są podane w dalszej części podręcznika. Na przykład, jeśli system chłodzenia jest używany tylko do chłodzenia niektórych leków, to tylko te procedury muszą być opisane.,
jeżeli można racjonalnie przewidzieć, że układ chłodzenia może być stosowany jako układ chłodzenia narządów, należy to opisać w instrukcji. W ten sposób Ty, jako producent, ograniczysz swoją odpowiedzialność i możesz skupić się tylko na opisaniu, jak używać systemu do chłodzenia leków.

działanie: napisz zamierzone użycie i racjonalnie przewidywalne niewłaściwe użycie produktu.


Rysunek 1. Rozsądnie przewidywalne nadużycie?,

napisz Ostrzeżenia dotyczące bezpieczeństwa na podstawie analizy ryzyka

nawet jeśli zamierzone zastosowanie zostało już jasno określone, nie oznacza to, że stosowanie produktu jest całkowicie pozbawione ryzyka.

aby zidentyfikować zagrożenia związane z używaniem produktu, można przeprowadzić analizę ryzyka. Analiza ryzyka może być również obowiązkowa w odniesieniu do niektórych grup produktów, takich jak urządzenia niskonapięciowe, zabawki, Maszyny i urządzenia do stosowania w atmosferach wybuchowych.

normy, takie jak ISO 12100, zostały opracowane, jak przeprowadzić analizę ryzyka., ISO 12100 podaje również metodę podejmowania środków łagodzących: metodę trzystopniową. Zgodnie z tą metodą istnieje następująca hierarchia środków zmniejszających ryzyko:

  1. z natury bezpieczne środki projektowe
  2. środki zabezpieczające i uzupełniające
  3. Informacje do stosowania

oznacza to, że podręcznik użytkownika powinien ostrzegać o wszelkich pozostałych ryzykach związanych z użytkowaniem produktu. Odbywa się to za pomocą ostrzeżeń dotyczących bezpieczeństwa.,

Kup Teraz

dobre ostrzeżenie dotyczące bezpieczeństwa opisuje charakter niebezpiecznej sytuacji, konsekwencje nie unikania niebezpiecznej sytuacji i metody jej unikania.

aby wskazać stopień zagrożenia, jakie może napotkać użytkownik, należy użyć słów sygnałowych „niebezpieczeństwo”, „Ostrzeżenie” i „Uwaga”.

zapoznaj się z poniższymi komunikatami dotyczącymi bezpieczeństwa:

Uwaga! Części obrotowe. Ryzyko poważnych obrażeń. Trzymaj ręce z dala. Lockout / Tagout przed serwisowaniem.

następnie chcesz ostrzec użytkownika, gdzie może wystąpić niebezpieczna sytuacja. ANSI Z535.,6 standard opisuje w instrukcji użytkownika następujące miejsca, w których może to być:

  • zgrupowane w osobnym rozdziale.
  • w pierwszej części konkretnej sekcji:
  • wbudowany w procedurę:

1. Zrób to.
2 . Zrób to. Uwaga! To są wbudowane komunikaty bezpieczeństwa. Tekst ogólny tekst ogólny tekst ogólny.
3. Zrób to.,

  • w przedmowie można umieścić wszelkie dodatkowe dyrektywy, takie jak przeczytanie wszystkich instrukcji przed użyciem lub zachowanie tych instrukcji dla przyszłych odniesień można umieścić we wstępie instrukcji obsługi.

w UE, w zależności od rodzaju produktu, może być dozwolone dostarczanie tylko informacji dotyczących bezpieczeństwa w formie drukowanej, a reszta informacji w Internecie.

aby pomóc Filipowi w stworzeniu i umieszczeniu komunikatu bezpieczeństwa, stworzyłem kolejny szablon.

działanie: przeprowadź analizę ryzyka i stwórz wiadomości dotyczące bezpieczeństwa za pomocą tego szablonu.,

Utwórz wszystkie inne treści

teraz poprosiłem Philipa o stworzenie wszystkich innych treści, takich jak procedury, specyfikacje techniczne i informacje prawne.

podałem następujące wskazówki:

  • Wyklucz zbędne materiały, aby uniknąć przeciążenia informacjami (np. promocja sprzedaży, obszerne powtórzenia itp.).
  • upewnij się, że warunki są znane użytkownikowi, funkcje techniczne i warunki są dobrze wyjaśnione i używaj terminów konsekwentnie.
  • opisz wszelkie warunki wstępne, które powinny zostać spełnione przed rozpoczęciem rzeczywistych instrukcji., Może to być również opisanie specjalnych narzędzi lub miejsca do konserwacji i naprawy.
  • dostarczają informacji koncepcyjnych, gdy informacje są niezbędne do właściwego zrozumienia i realizacji zadań.
  • zawsze pisz na podstawie tematu.
  • użyj czcionek pogrubionych dla wszystkich elementów produktu.
  • użyj przewodnika po stylach, aby pomóc ci pisać i formatować dokumentację w jaśniejszy sposób.
  • wskaż, kiedy chcesz dodać obraz dla lepszego zrozumienia później.
  • upewnij się, że słowa i zwroty nie są zbyt skomplikowane lub zbyt skomplikowane.,
  • używaj prostych / ustandaryzowanych i krótkich zwrotów: jedno zdanie-jedno polecenie.
  • nie umieszczaj zbyt wielu informacji w jednym zdaniu.
  • użyj bezpośredniego aktywnego głosu i poleceń asertywnych.
  • używaj słów takich jak rzeczowniki i czasowniki konsekwentnie, aby uniknąć dwuznaczności.
  • aby pisać lepsze instrukcje, użyj zasad minimalizmu w komunikacji technicznej i uproszczonego języka technicznego.

Akcja: Utwórz wszystkie inne treści do podręcznika użytkownika.

dla większości grup produktów dostępne są płatne szablony, które mogą ułatwić pracę., Szablony te zawierają wszystkie teksty prawne, obowiązkowe informacje dotyczące usuwania, oświadczenia dotyczące praw autorskich i są zgodne ze standardem IEC 82079 w instrukcjach użytkownika.

umieść ostrzeżenia o bezpieczeństwie we właściwej pozycji

korzystając z szablonu do tworzenia komunikatów o bezpieczeństwie, poprosiłem Filipa o wskazanie, czy komunikat o bezpieczeństwie jest dyrektywą uzupełniającą, czy powinien być umieszczony jako pogrupowany, sekcja lub osadzony komunikat o bezpieczeństwie.

teraz został utworzony cały tekst, komunikaty bezpieczeństwa można umieścić we właściwym miejscu.,

Akcja: umieść wszystkie komunikaty bezpieczeństwa we właściwym miejscu w instrukcji obsługi.

Krok 9 Dodaj nawigację do szablonu instrukcji obsługi

Instrukcja obsługi powinna pomóc ludziom, dostarczając informacji o tym, jak korzystać z produktu. Znalezienie odpowiednich informacji, które rozwiązują problem użytkownika, powinno zająć jak najmniej czasu.

tworzenie znaczących nagłówków jest jednym z narzędzi, które pomagają użytkownikom w znajdowaniu informacji., Istnieje jednak kilka innych narzędzi, które pomagają użytkownikowi znaleźć pożądane informacje, takie jak:

  • spis treści
  • numeracja stron
  • indeks

poprosiłem Filipa o aktualizację spisu treści i dodanie numeracji stron oraz indeksu.

Akcja: Dodaj lub zaktualizuj spis treści, numerację stron i indeks.

krok 10 przejrzyj instrukcję obsługi

Filip stworzył wersję roboczą swojej instrukcji obsługi, używając szablonu instrukcji obsługi. Tę wersję nazywamy projektowaniem treści tekstowych.,
ponieważ Philip ma partnera biznesowego i programistę z dogłębną wiedzą techniczną o produktach, poprosiłem Philipa, aby pozwolił im przejrzeć dotychczasową pracę.
zarówno jego partner biznesowy, jak i deweloper udzielili opinii. Philip wykorzystał tę opinię, aby zoptymalizować instrukcję obsługi.
działanie: Wyślij wersję roboczą instrukcji obsługi do każdego z członków Twojego zespołu, który może być w stanie dostarczyć opinię. Poproś ich, aby połączyli wszystkie opinie w jeden dokument przed odesłaniem go do ciebie. Stymuluje to dyskusję członków zespołu i zapobiega niezgodie na późniejszym etapie.,

krok 11 Utwórz obrazy

po przejrzeniu i zoptymalizowaniu instrukcji obsługi teksty są mniej lub bardziej określone. Oznacza to, że wszelkie obrazy mogą być teraz tworzone i dodawane do treści.

powodem, aby czekać, aż teksty będą gotowe, jest to, że tworzenie lub edycja obrazów może być czasochłonne. Ponieważ obrazy powinny wspierać, zastępować lub rozszerzać tekst, należy poczekać na ich utworzenie, aż teksty będą ostateczne.

obrazy w podręcznikach użytkownika mogą zawierać ilustracje, zdjęcia, zrzuty ekranu, tabele,schematy i schematy.,

istnieje wiele świetnych narzędzi, które mogą pomóc w tworzeniu obrazów, takich jak:

  • Snagit lub Adobe Photoshop do edycji zrzutów ekranu lub zdjęć
  • Solidworks Composer lub Google Sketchup do tworzenia rysunków liniowych
  • Lucidchart lub Microsoft Visio do diagramów i schematów

radziłem Filipowi, aby nie używał zdjęć jako taniej alternatywy dla ilustracji. Często zdjęcia nie są tak pouczające, ponieważ zawierają zbyt wiele informacji. Poza tym zdjęcia mogą sprawić, że instrukcja obsługi będzie wyglądać bałagan.,

z tego powodu Philip wykorzystał Google Sketchup do tworzenia swoich ilustracji.

Akcja: tworzenie obrazów do podręcznika użytkownika.

Jeśli chcesz wiedzieć więcej o tworzeniu obrazów:

  • za pomocą tekstu, obrazów lub wideo
  • Tworzenie podręczników IKEA-owskich

krok 12 ostateczne sprawdzenie szablonu instrukcji obsługi

zanim zaczniemy ładnie wyglądać i tłumaczyć zawartość, chcemy mieć pewność, że treść jest kompletna.

w tym celu poprosiłem Filipa o użycie listy kontrolnej.,

działanie: l upewnij się, że instrukcja obsługi spełnia wszystkie odpowiednie wymagania normy IEC 82079-1:2012, korzystając z tej listy kontrolnej.

krok 13 Zaprojektuj szablon instrukcji obsługi

dobrze zaprojektowany podręcznik przyczynia się do lepszej marki i doświadczenia użytkownika.

można dostosować szablon instrukcji obsługi w MS Word dodając logo firmy i dostosować czcionkę, kolory itp., Ale To może mieć ograniczenia.

gdy wiesz, jak pracować z Adobe Indesign, lub chcesz nauczyć się z nim pracować, zaoferuje ci to znacznie większe możliwości projektowe.,

stworzyłem ten szablon w Indesign i poprosiłem Filipa o dostosowanie go do jego tożsamości marki.

działanie: Dostosuj szablon instrukcji obsługi do swojej tożsamości marki lub Pobierz szablon instrukcji obsługi programu InDesign i dostosuj go.

krok 14 prace DTP

DTP oznacza Desktop Publishing, a Wikipedia opisuje go jako „tworzenie dokumentów za pomocą umiejętności układania stron na komputerze osobistym głównie do druku”.

Philip ma teraz zarówno zawartość swojej instrukcji obsługi (plik Word), jak i szablon instrukcji obsługi (plik InDesign)., Zawartość należy umieścić w szablonie InDesign. To się nazywa Desktop Publishing.

Akcja: umieść zawartość pliku Word w szablonie programu Indesign. Jeśli zdecydowałeś się nie używać szablonu InDesign, ale utknąłeś w pliku Word, możesz pominąć ten krok.

krok 15 Przetłumacz i opublikuj instrukcje obsługi

w zależności od Rynku, na którym zamierzasz sprzedawać swój produkt, może być konieczne przetłumaczenie instrukcji obsługi.

kilka ogólnych wskazówek:

  • poszukaj tłumacza z podobnym doświadczeniem., Może to być tłumacz, który ma doświadczenie w tłumaczeniu treści technicznych, z podobnymi produktami lub z tłumaczeniem instrukcji obsługi.
  • jeśli potrzebujesz przetłumaczyć na kilka języków, praca z Biurem Tłumaczeń może zaoszczędzić wiele czasu.
  • zapytaj tłumacza lub agencję o ich procedury jakościowe i kto będzie poprawiał tekst po tłumaczeniu.
  • ponieważ znasz swój produkt najlepiej i kim są Twoi odbiorcy, dobrym pomysłem może być dostarczenie tłumaczowi lub agencji słowniczka lub listy z terminologią, której chcesz użyć.,
  • poszukaj tłumacza, który może pracować bezpośrednio w Twoim pliku Word lub InDesign lub znajdź agencję, która również wykona prace DTP. Oczywiście możesz to zrobić samodzielnie.

ponieważ Philip będzie sprzedawać swój produkt zarówno w USA, jak i w UE, zdecydował się na współpracę z agencją.

działanie: Znajdź tłumacza lub agencję dostosowaną do Twoich potrzeb i zleć przetłumaczenie instrukcji obsługi.

ogólnie rzecz biorąc, podręcznik użytkownika powinien być dostępny w formacie, który jest łatwo dostępny dla użytkownika. Które mogą być drukowane lub używane online lub na urządzeniu.,

ponieważ użytkownik chce informacji w tej chwili potrzebuje jej, a więc nie myśli w kanałach, najlepszym podejściem byłoby dostarczenie instrukcji omni-platform.

w Unii Europejskiej, dla niektórych grup produktów, nadal jest ograniczona do dostarczenia instrukcji obsługi wydrukowanej razem z produktem.
jednak od kwietnia 2016 r. instrukcje dla wielu grup produktów mogą być dostarczane w innym formacie, a nie w formie drukowanej. Jest jednak jeden wyjątek.

informacje dotyczące bezpieczeństwa powinny być nadal dostarczane wraz z produktem w formie papierowej., Ponadto na żądanie konsumenta należy udostępnić konsumentowi papierową instrukcję obsługi.

Philip zdecydował się na następujące czynności:

  • dostarcza wydrukowaną pełną instrukcję z produktem, w tym instrukcje bezpieczeństwa.
  • stworzył osobny przewodnik szybkiego startu, który można również dostarczyć wraz z produktem.
  • umieścił w Internecie pełną wersję podręcznika w formacie pdf.
  • stworzy on sekcję pomocy online na swojej stronie internetowej w wersji HTML podręcznika użytkownika. Tutaj też może dodawać filmy., A optymalizując wersję HTML pod kątem wyszukiwarek ułatwia użytkownikowi znalezienie informacji dla użytkownika

To wszystko. W ten sposób Philip stworzył zgodną instrukcję obsługi z pomocą szablonu podręczników użytkownika i innych dostępnych narzędzi, które dostarczyłem.

najlepsze w tym wszystkim jest to, że możesz uzyskać te same wyniki, Co Philip, wykonując ten krok po kroku proces tworzenia instrukcji użytkownika.