Jak napisać przewodnik: 7 kroków

Tutorial to zbiór instrukcji (książka). Podręcznik ma zapewnić przegląd tematu przed zajęciami klasowymi, abstrakcjami na zajęcia podczas kursu szkoleniowego, odniesienie do odniesienia do następującego i ogólnego odniesienia.Użyj tych kroków, aby napisać podręcznik.

Kroki

jeden. Naucz się swojej publiczności. Poznawaj poziom wiedzy i doświadczenia publiczności, biorąc pod uwagę usługę, system lub produkt adresów instrukcji badawczej.

Użyj prostego języka i podaj obszerny system lub treść informacji referencyjnych dla nowych gunży. Nowi użytkownicy powinni nie uczyć się produktu lub systemu, ale jak ich używać.
Użyj terminologii wyższego poziomu i mniej informacji referencyjnych dla grup, które znają produkt lub system. Istniejący użytkownicy lub użytkownicy produktów mogą wymagać wiedzy o nowych dodatkowych funkcjach.

Obraz zatytułowany Napisz podręcznik szkoleniowy Krok 2

2. Napisz plan. Schemat pomaga zorganizować informacje. Pomoże to również upewnić się, że wszystkie elementy systemu lub produktu są ujawniane w instrukcji badawczej.

Obraz zatytułowany Napisz instrukcję obsługi Krok 3

3. Zacznij od orientacji. Zarysuj strukturę firmy, ról i obowiązków. Wyobraź sobie standardową procedury SOP działającego (pracy), dyrektywy i wskaźniki QA (kontrola jakości). Przejrzyj kilka zasad ogólnych krótko, być może przez listy lub użycie słów kluczowych. Ogólnie rzecz biorąc, nie myśl, że czytelnik wie coś o temacie, a nawet organizacji i określa rzeczy jasne.

Przylegać do krótkiej orientacji na zasługi. Przeczytaj ponownie i wybierz wszystkie niepotrzebne dodatki.

Obraz zatytułowany Napisz instrukcję obsługi Krok 4

cztery. Napisz członek. Uruchom każdy rozdział od przeglądu informacji prezentowanych na następnych stronach. Użyj nagłówków, aby zorganizować informacje na mniejsze sekcje w każdym rozdziale.

Rozpocznij każdy krok lub kierunek z akcji czasownika.

Trzymaj się krótkich dyrektyw i zasadniczo.

Prześlij dowolne informacje referencyjne w oddzielnych dziedzinach znaków, aby utrzymać wszystko razem i pomóc użytkownikom mieć proces od początku do końca.

jeden
OSTRZEŻENIE Użytkownicy do każdego alternatywnego sposobu wykonania kroków. Jeśli uzupełnienie akcji jest więcej niż 1 sposób, zaznacz go w podręczniku.
Włącz zrzuty ekranu, jeśli jest dopuszczalne. Zrzuty ekranu System zapewniają dodatek wizualny, który uzupełnia instrukcje tekstowe.
2. Zrób oddzielne podsumowanie odcinków lekcji. Napisz krótki przegląd istoty informacji zawartych w każdej sekcji. Użyj tabel referencyjnych dla wszelkich informacji, na których możesz regularnie odnieść się do użytkowników regularnie, na przykład, kluczowe kombinacje lub definicje pola.
Włóż ostateczne sekcje lekcji po zakończeniu każdego rozdziału. Utwórz aplikację lub linki na końcu podręcznika i włącz tam wszystkie lekcje CV.
3. Spędź trening próbny. Wybierz grupę uczestników, którzy przypomina grupę, która będzie korzystać z ostatecznej instrukcji produktów. Niech grupa użyje samouczek i zapewnić przeglądu czytelności, obszarów do poprawy i sekcji, które wymagają mniej lub bardziej szczegółowej prezentacji.
cztery. Zmień instrukcje. Użyj opinii (recenzje) uzyskanych z grupy testowej, aby wprowadzić zmiany w treści lub obfitości zarządzania.
Wyślij instrukcje do grupy redaktorów lub pracowników. Poproś ich, aby dostosowali gramatykę i interpunkcję z korzyści.

Rada

Dołącz formularz zwrotny (recenzje) w instrukcji badawczej. Użytkownicy samouczków mogą mieć sposób na wysłanie wszelkich sugestii lub zmian w księgowaniu w klasie lub jako dokumentacja dokumentu lub produktu.