Jak zrobić instrukcję obsługi: 12 kroków

Podręcznik użytkownika to papier na papierze lub media cyfrowe (w formacie PDF lub XPS), w którym instrukcje dotyczące korzystania z czegoś lub opisuje prawidłową procedurę wykonania procesu. Chociaż, gdy osoba usłyszy frazę "instrukcja obsługi", Zwykle reprezentuje przewodnik do korzystania z konkretnego programu, instrukcji obsługi urządzeń komputerowych i domowych (telewizory, systemy stereo, telefony, odtwarzacze MP3, sprzęt ogrodowy i i t.RE.). Dobry podręcznik użytkownika informuje o podstawowych funkcjach urządzenia lub programu i wyjaśnia, jak ich używać prawidłowo, a informacje są zazwyczaj dobrze zorganizowane. Ten artykuł opowie o tym, co ważne jest pamiętanie podczas tworzenia i wykonania instrukcji obsługi.

Kroki

Część 1 z 3:

Tworzenie dokumentacji

jeden. Określ kim czytelnik. Aby utworzyć dobrą instrukcję, musisz zrozumieć, która osoba kupi urządzenie, do którego tworzysz instrukcje. Możesz nagrać swoje myśli, ale możesz wyobrazić sobie tę osobę. Przydatne jest, jeśli pracujesz jako zespół, aby utworzyć dokumentację i jeśli uczestniczysz w rozwoju produktu od samego początku do końca. Pomyśl o następujących:

Gdzie osoba będzie korzystać z instrukcji obsługi: w domu, w pracy, w samochodzie, w Internecie? Spowoduje to określenie nie tylko treści, ale także styl dokumentacji.
Jako osoba wykorzysta instrukcje? Jeśli osoba potrzebuje tylko sporadycznie zajrzeć do instrukcji obsługi, oznacza to, że instrukcja musi być oprawiona w sprężonej formie. Jeśli instrukcja jest często używana, zwłaszcza na samym początku, należy dołączyć całą sekcję, jak rozpocząć korzystanie z urządzenia lub oprogramowania i opisać wszystkie najważniejsze funkcje.
Ile doświadczenia powinno mieć osobę? Jeśli twój produkt jest stosunkowo nowy lub znacząco różny od podobnych produktów, należy dołączyć informacje o tym, jak ten produkt różni się od analogów i zapewnić użytkownikowi szczegółowe instrukcje. Jeśli towary są związane z częstymi problemami (na przykład z dużą liczbą programów), opisz, co należy zrobić, gdy pojawi się problem.

Obraz zatytułowany Utwórz instrukcję obsługi Krok 2

2. Napisz, aby czytelnik cię rozumie. Jeśli tylko twój produkt nie oznacza wąskiej znajomości użytkownika, lepiej uniknąć warunków technicznych i opisać wszystko prostym, zrozumiałym językiem. Struktura tekstowa musi być zgodna z sekwencją pytań, które mogą wystąpić przez użytkownika. Bardziej poprawne jest grupę funkcji urządzenia w zależności od zadań, które wykonuje i porzucić ideę zjednoczenia w jednej grupie najpopularniejszych funkcji.

Czasami niemożliwe jest całkowicie wykluczyć warunki techniczne (na przykład, jeśli wprowadzisz instrukcje do programu do tworzenia wykresów i diagramów, gdzie oprócz standardowych funduszy, również używane są również instrumenty graficzne Fibonacci). W takim przypadku przydatne jest określenie terminu i krótkiego opisu (to znaczy, jaka jest grafika Fibonacci i jak są one używane w analizie wskaźników finansowych).

Obraz zatytułowany Utwórz instrukcję obsługi Krok 3

3. Opisz problem, z którym użytkownik może napotkać, a następnie oferować rozwiązanie. Kiedy reklamujesz jakiś rodzaj produktu, frazy o tym, jak może rozwiązać pewien problem, niewątpliwie przyciągnie wiele uwagi. Ale kiedy użytkownik kupuje ten produkt, musi wyjaśnić, co z tym zrobić. Opisz, z jakim problemami użytkownik może napotkać podczas pracy, a także w instrukcji ręcznych dla ciągłych problemów.

Jeśli problem jest skomplikowany, włóż go na kilka części. Zrób listę i towarzyszyć każdej instrukcji elementów. Nazywa się to blokami.

Część 2 z 3:

Composite części instrukcji obsługi

jeden. Rozważmy pokrywę i projektowanie pierwszych stron sekcji. Musisz utworzyć okładkę, jeśli instrukcja zajmuje kilka stron. Konieczne będzie również umieszczenie stron z nazwą sekcji w celu uzyskania instrukcji, w których łączna ilość informacji zajmuje więcej niż 4 strony.

Jeśli instrukcja obsługi jest chroniona prawami autorskimi, odpowiednie wskazanie musi znajdować się na pokrywie i na stronach partycji.
Jeśli instrukcja obsługi zapewnia pewne warunki korzystania z produktu i instrukcji, umieść te informacje od wnętrza pokrywy.

Obraz zatytułowany Utwórz instrukcję obsługi Krok 5

2. Linki do dodatkowego miejsca dokumentacji we wstępie. Jeśli podręcznik składa się z kilku broszur, określ wszystkie broszury na początku. Ponadto powinien również umieścić sekcję "Jak korzystać z tej instrukcji obsługi", Jeśli zdecydujesz, że taka sekcja jest konieczna.

Obraz zatytułowany Utwórz podręcznik użytkownika Krok 6

3. Jeśli liczba stron przekracza 10 sztuk, będziesz potrzebować spisu treści.

Obraz zatytułowany Utwórz instrukcję obsługi Krok 7

cztery. Podstawą instrukcji obsługi powinno być instrukcje i informacje na temat składników towarów. Z reguły instrukcje są uszkodzone w bloki, aw każdym bloku możesz określić, w jakich sekcjach użytkownik powinien szukać tego lub tych informacji. Więc użytkownik będzie łatwiejszy i szybszy, aby znaleźć potrzebne informacje.

Procesy powinny być opisane jasno i konsekwentnie. Zacznij od ogólnego opisu zadania, a następnie wyjaśnij, że użytkownik będzie musiał zrobić i jaki wynik będzie musiał uzyskać. Wszystkie kroki muszą być ponumerowane, a propozycje powinny zaczynać się od czasowników.

Materiały odniesienia powinny zawierać listę funkcji, metody diagnozowania błędów i często zadawane pytania. Na końcu podręcznika użytkownika można umieścić krótki słownik terminów i alfabetycznego wskaźnika, chociaż główne terminy są często wykonane na początku. Wskaźnik alfabetu jest zalecany do instrukcji, których wolumin przekracza 20 stron.

Obraz zatytułowany Utwórz podręcznik użytkownika Krok 8

pięć. Użyj obrazów i schematów. Rysunki i zrzuty ekranu mogą opisać pewne procesy lepsze niż tekst, zwłaszcza jeśli pochodzi z złożonych procesów, w których musisz mieć wizualne potwierdzenie, że osoba robi wszystko dobrze. Obrazy graficzne można tworzyć w specjalnych programach: w systemach dwóch i trójwymiarowych rysunków, w edytorach graficznych, w aplikacjach do przetwarzania zdjęć itp.RE. Jeśli należy wykonać zrzuty ekranu, można je uzyskać za pomocą personelu kompetetowca i programu graficznego z możliwością oszczędzania ekranu.

Po otrzymaniu obrazu graficznego zapisz go w skompresowanym formacie. Może być również konieczne zmniejszenie rozmiaru obrazu, dzięki czemu jest umieszczony na stronie, ale rozmiar nie powinien być zbyt mały, ponieważ w przeciwnym razie użytkownik nie będzie w stanie rozważyć, jak i co należy zrobić. W razie potrzeby możesz złamać obraz na kilka części i opisać każdy z nich.

Jeśli używasz wielu zdjęć, muszą mieć ten sam rozmiar, proporcję i rozdzielczość. Takie obrazy będą bardziej zrozumiałe i przyjemne dla czytelnika. Podczas tworzenia zrzutów ekranu upewnij się, że używasz standardowego schematu kolorów (w przypadku przypadków, gdy podręcznik jest drukowany w kolorze).

Chociaż edytory graficzne (na przykład Photoshop i Paint Shop Pro) są wygodne do tworzenia zrzutów ekranu, lepiej jest korzystać z specjalnych programów (na przykład, snagit), ponieważ pozwalają im być natychmiast szybki i łatwy do edycji, oszczędzania i podpisać wszystkie obrazy.

Część 3 z 3:

Rejestracja podręcznika

jeden. Wybierz czytelną czcionkę. Chociaż komputery obsługują różne czcionki, instrukcja obsługi musi być dobrze czytelna, więc zapewnij najprostsze. Najlepiej wybrać kilka czcionek, które wyglądają dobrze razem. Istnieją dwa typy czcionek: z serifami i bez trampków.

Czcionki z serifami mają małe kreski wzdłuż krawędzi linii. Takie czcionki obejmują Times New Roman, Baskerville i Book Antiqua. Takie czcionki pasują do dużych ilości tekstu wydrukowanego przez 10 lub 12 rozmiarów i składnika instrukcji obsługi.
Czcionki bez trampków mają proste linie bez dekoracji. Są to czcionki, takie jak Arial, Calibri i Century Gothic. Czcionki bez serifów lepiej wyglądają w tekstach wydrukowanych przez 8 lub 10 czcionek w podręcznikach PDF lub dokumentu Web. Im większa czcionka, tym trudniej jest czytać go bez trampków. Jednak te czcionki mogą być używane do dużego tekstu - na przykład dla zestawu nagłówków. Czcionki narzekujące są odpowiednie do rekrutacji cyfry w tabelach i kolumnach.
Powinieneś wybrać proste czcionki, takie jak Arial lub Times New Roman, chociaż niektóre bardziej złożone czcionki nadaje się do cytatu. Jeśli napiszesz instrukcję dla gry fantasy, możesz podświetlić tytuł tytułu apostowego. Pozwolono mu również szyć cytat w kursywkach.
Po wybraniu czcionek utwórz stronę testową, aby upewnić się, że te czcionki są połączone ze sobą na papierze. Pokaż tę stronę osobie, która zatwierdza układy przed podaniem instrukcji do drukowania.

Obraz zatytułowany Utwórz podręcznik użytkownika Krok 10

2. Pomyśl o schemacie lokalizacji bloków informacji. Na tym etapie musisz zdecydować, jakie informacje o zamówieniach.

Z reguły nazwa podręcznika użytkownika i nazwy rozdziałów umieszcza się na górze lub na dole strony wraz z numerami numerującymi. Figury mogą znajdować się na zewnątrz (dla góry i dołu strony) lub w środku (dla NIZA). Pierwsza strona każdej sekcji może się różnić od reszty, dzięki czemu możesz umieścić jego numer swojej strony na środku dołu, a numery wszystkich innych stron - z zewnątrz.

Oddzielne fragmenty tekstu można wyizolować kolor, umieszczając je w specjalnych blokach. Ważne jest, aby wybrać taki odcień, który nie zdobędzie tekstu.

Zostaw dość dużych wcięć ze wszystkich stron. Z wiązania wcięcia musi być szersze.

Obraz zatytułowany Utwórz podręcznik użytkownika Krok 11

3. Pomyśl o rodzaju wiązania. Jeśli istnieje więcej niż 4 strony w instrukcji obsługi, będziesz potrzebować wiązania. Dokumenty do użytku wewnętrznego zazwyczaj mocują zszywacz w rogu, ale jeśli zainwestujesz przewodnik po polu, musisz podejść do tej kwestii bardziej odpowiedzialnie. Istnieją trzy typy wiązania:

Bracket. Ten typ nadaje się do broszur o wymiarach 21x 27.5 cm, 21x35 cm lub 11 x 27.5x42.5 cm. Najbardziej niedrogie instrukcje użytkowania, które składają się z 48 stron i mniej powiązane w ten sposób.

Wiązanie VNAKidka. Splecij więc większość zwykłych instrukcji użytkowania, nie licząc instrukcji dla samochodów, chociaż niektórzy długie przywódcy są również splecione w ten sposób. Paint Shop Pro został pierwotnie dostarczany z taką instrukcją obsługi.)

Wiązanie z spiralą drutu. W ten sposób podręczniki używane w bardziej ciężkich warunkach są splecione, na przykład, na ulicy, gdzie zszywki mogą łatwo pękać lub rozpraszać. W niektórych instrukcjach do użytku z taką wiązaniem znajdują się również strony laminowane, które nie są mokre i nie brudne w brudu.

Obraz zatytułowany Utwórz instrukcję obsługi Krok 12

cztery. Weź dokument. Większość redaktorów i programów do wydawania tekstu w Internecie istnieje szansa na układ. Jak wpisujesz tekst, zostanie automatycznie wyświetlony w wybranej czcionce. (Ten artykuł został pierwotnie napisany za pomocą szablonu w programie Microsoft Word.) Te programy mają również gotowe szablony, które można zmienić, biorąc pod uwagę swoje potrzeby, zamiast tworzyć wzór od podstaw.

W edytorach tekstowych i programach do publikowania tekstu w Internecie istnieje również funkcja tworzenia "style", Zapisywanie czcionek i zadań zadań dla tabel i stopek i podstawowy tekst. Możesz wybrać już istniejące style ("Tytuł1", "Normalna", "Zacytować") lub stwórz własny styl i daj mu swoje imię. Zaleca się, aby zadzwonić do stylów wzdłuż tego samego systemu, co podane w programie. (Na przykład Microsoft Word tworzy takie nazwy jak "Tytuł1", "Tytuł2"- Ponadto nadal są napisy.) Z góry skonfiguruj program, aby nie do niego wracać do niego, gdy napiszesz pisanie tekstu.

Rada

Jeśli to możliwe, użyj kodów pól lub zmiennych tekstowych. Możesz zmienić swoje wartości (na przykład nazwę produktu, nazwę głowy podręcznika użytkownika) i umieść je w dokumencie w miejscu, w którym zwykle przesuwasz się do słów ręcznie. Po wykonaniu podglądu dokumentu lub przygotuj go do drukowania, żądany tekst ustawi się na zmienne. Jeśli nazwa zmiany towarów lub zdecydujesz się zmienić nazwę rozdziału, łatwiej będzie zmienić tekst, zastępując wartość zmiennej.

Czego potrzebujesz

Edytor tekstu lub program do publikowania tekstu w Internecie
Edytor graficzny lub program do tworzenia zrzutów ekranu