Bez względu na to, jak pomysłowy może być wynalazca, programista czy racjonalizator, czasami jego kreacje po prostu nie mogą być użyte zgodnie z ich przeznaczeniem. Powodem tego jest błędnie sporządzona instrukcja obsługi lub jej całkowity brak. Ale nawet pomysłowi wynalazcy piszą czasem takie instrukcje, że poza wąskimi specjalistami nikt nie potrafi czytać tych prac. Jak więc właściwie sporządzić tak niezbędny dokument?
Czy to jest to konieczne
- - stuprocentowa znajomość urządzenia lub oprogramowania, dla którego pisana jest instrukcja;
- - wiedza z zakresu językoznawstwa;
- - umiejętność pisania.
Instrukcje
Krok 1
Instrukcja obsługi lub innymi słowy instrukcja obsługi to dokument mający na celu pomoc w korzystaniu z określonego systemu dla jego użytkowników. Aby skompilować instrukcję obsługi, musisz znać opisany system w stu procentach, ale spójrz na niego oczami nieświadomego ucznia. Załóżmy, że instrukcja obsługi została napisana dla narzędzia programowego, które nie ma jeszcze odpowiedników. Wyobraź sobie, że używasz tego programu po raz pierwszy. Od czego zaczynasz? Jaka jest pierwsza rzecz, którą należy wiedzieć? Uporządkuj tę wiedzę w kategorie ważności.
Krok 2
Dzieląc wszystkie informacje dotyczące swojej twórczości na grupy, opracowałeś plan napisania instrukcji obsługi. Zacznij od podstaw opisywać pracę w swoim programie, zostawiając na koniec najtrudniejsze szczegóły, takie jak przeprogramowanie funkcji czy radzenie sobie z krytycznymi błędami. Na tym etapie powinieneś mieć przygotowaną treść podręcznika użytkownika - jednej z wymaganych części tego dokumentu.
Krok 3
Jeśli tworzony podręcznik jest przeznaczony do użytku w dużej firmie, należy zwrócić uwagę na przyjęte tam standardy korporacyjne. Na przykład w wielu rosyjskich firmach instrukcje obsługi nie są akceptowane bez wsparcia ilustracyjnego, innymi słowy, zdjęć wyjaśniających, co jest napisane. Oprócz treści instrukcja obsługi powinna zawierać inne obowiązkowe części: - adnotację, czyli wyjaśnienie ogólnych celów instrukcji i opisywanego produktu, - wprowadzenie, w którym opisano dokumenty związane z instrukcją obsługi oraz sposób do korzystania z instrukcji, - rozdziały wyjaśniające użytkowanie produktu na różnych etapach jego użytkowania, np. pierwsze kroki, naprawa lub konserwacja, - dział z najczęściej zadawanymi pytaniami i odpowiedziami na nie, - słowniczek lub indeks tematyczny.
Krok 4
Zazwyczaj w tworzenie instrukcji obsługi zaangażowany jest pisarz techniczny - osoba, która posiada niezbędną wiedzę zarówno w języku, jak i opisywanym produkcie. Jako pisarz techniczny bez przeszkolenia należy pamiętać o kilku zasadach. Po pierwsze, nie wolno nadużywać specjalnych warunków, które nie są zrozumiałe dla zwykłego użytkownika. Po drugie, każdy użyty termin musi być uszczegółowiony i wyjaśniony. Po trzecie, musisz pisać tak jasno i zwięźle, jak to możliwe. Wreszcie, pisarz techniczny musi być w stanie spojrzeć na swój tekst oczami zwykłego użytkownika, aby dostrzec wady własnego tekstu.
Krok 5
Gotowy tekst instrukcji dobrze jest przetestować w praktyce, proponując go osobie, która nie miała nic wspólnego z opisywanym produktem. Dzięki wspólnym wysiłkom możliwe jest wyeliminowanie wszystkich niedociągnięć i pułapek dokumentu.
