Jak napisać świetny podręcznik dla prawie wszystkiego

Spisu treści:

Anonim

Dawno temu, solidne podręczniki użytkownika towarzyszyły nowym produktom każdego rodzaju, dostarczając obszernych instrukcji, jak nauczyć się wszystkich funkcji i maksymalizować wykorzystanie. Obecnie jednak podręczniki użytkownika dostarczane przez producenta są znacznie bardziej pobieżne i często w wielu językach, co komplikuje krzywą uczenia się. Posiadanie przyzwoitego podręcznika użytkownika jest cennym towarem, a jeśli wiesz, jak go napisać, jest to bardzo poszukiwany talent. Jest to po prostu kwestia opanowania kilku kluczowych zasad.

Przedmioty, które będą potrzebne

  • Microsoft Word lub inny program do edycji tekstu

  • Kolekcja obiektów clipart lub fotografii cyfrowych

  • Proste oprogramowanie do tworzenia stron internetowych

Zdecyduj się na format, czy drukowane dokumenty, strony internetowe, e-maile lub niektóre kombinacje. Po napisaniu w jednym formacie można go łatwo przenieść do innego. Niektórym wygodniej jest czytać drukowany dokument, który mogą przechowywać i złożyć. Inni mogą preferować URL lub link do dokumentu w Twojej witrynie.

Bądź zorganizowany, jasny i zwięzły. Przewiduj i wyjaśnij nie tylko, co użytkownicy będą robić, ale także czego nie robić. Musisz pisać z myślą o obu.

Zacznij od początku, rozkładając tylko niezbędne informacje w logiczny sposób. Pisz aktywnym głosem, nie pasywnym. Utrzymuj swoją kopię w chudej, eliminując zbędne słowa. Zachowaj to proste i metodyczne.

W miarę możliwości rozbijaj tekst ze zdjęciami, ilustracjami lub diagramami. Czynienie czytelników przeglądaniem niekończących się tekstów za pomocą monstrualnych paragrafów jest pewnym sposobem na ich utratę. Długie, złożone akapity i strony są odpowiednie dla podręczników technicznych, ale nieodpowiednie dla prostych instrukcji obsługi. Zachowaj krótki i słodki.

Ostrzeż czytelnika, czego nie robić w różnych odstępach czasu. Pomaga to zminimalizować frustrację podczas nauki nowego produktu lub aplikacji.

Zapewnij czytelnikom inne zasoby, których mogą użyć, aby uzupełnić swój przewodnik.

Wskazówki

  • Napisz w bardzo prosty sposób. Nie zakładaj żadnego poziomu wiedzy. To, co wydaje się łatwe i kompetentne, może nie być takie dla twoich czytelników. Użyj wysokiej jakości grafiki, obiektów clipart i zdjęć, aby poprawić wygląd dokumentu i poprawić czytelność. Zachowaj krótkie akapity i opisy.

Ostrzeżenie

Nigdy nie zakładaj, że czytelnik zna produkt. Napisz każdego przewodnika tak, jakby nigdy go nie widział.