Utwórz skuteczny poradnik, który zaangażuje odbiorców

Jak często współpracownicy przerywają Ci, prosząc o pomoc?

Czy wiesz, że 46% pracowników przerywa pracę częściej niż sześć razy dziennie? W naszym badaniu dotyczącym elastyczności miejsca pracy pracownicy ci zgłaszali obniżoną produktywność lub większy poziom stresu.

Popraw jakość życia wszystkich dzięki niewielkiej dokumentacji. Tutaj znajdziesz wszystko, czego potrzebujesz, aby wygodnie i pewnie tworzyć instrukcje krok po kroku.

Możliwości dzielenia się procedurami, wyjaśnieniami i metodami są wszędzie.

• Czy szkolisz członków zespołu w zakresie nowego procesu?
• Czy zachęcisz klientów do swojego komercyjnego produktu lub usługi?
• Ułatwić otwartą rejestrację w nowym oprogramowaniu HR?
• Poinstruować, jak opróżnić fusy po kawie?
• Wnieść wkład w bazę wiedzy klientów?

Nauczmy się, jak stworzyć poradnik.

Przestań powtarzać pytania

Twórz przejrzyste filmy i przewodniki za pomocą Snagit, dzięki czemu będziesz musiał wyjaśniać zadania tylko raz.

Wypróbuj za darmo

Instrukcje krok po kroku stanowią część wewnętrznej bazy wiedzy

Szybki samouczek to przewodnik krok po kroku dotyczący wykonania określonego zadania.

• Jasne – czytelnicy powinni być w stanie wykonać kolejne kroki. Często oznacza to łączenie tekstu ze zdjęciami lub filmami.
• Angażowanie – Zorganizuj przewodnik tak, aby przyciągnąć uwagę czytelników i pomóc im zaoszczędzić czas.
• Istotne informacje – Podaj kontekst i przypadki użycia, które pomogą czytelnikowi zrozumieć, dlaczego jest to dla niego cenne.

Inne ważne części bazy wiedzy różnią się

• Podręcznik szkoleniowy – nie próbuj zastępować dogłębnego szkolenia ani kursu certyfikacyjnego.
• Przewodnik referencyjny — skup się na jednym konkretnym celu, jaki mogą osiągnąć Twoi odbiorcy.
• Podręcznik użytkownika – zawiera kilka wskazówek, ostrzeżeń lub warto wiedzieć, a nie każdy scenariusz brzegowy.
• Posty na blogu — Uprość treść strategii marketingowych skierowanych do klienta i kampanii marketingowych. Możesz też zastąpić studiami przypadków lub listami punktowanymi, aby pomóc w podejmowaniu decyzji o zakupie.

Krok 1: Zrozum bolączki swojej grupy docelowej

„Zmierz dwa razy, przetnij raz”. Warto poświęcić dodatkowy czas na obsługę, aby zapewnić satysfakcję klienta.

Zidentyfikuj ich bolesne punkty

Zanim zaczniesz, określ grupę docelową, jej cele, bolesne punkty lub luki w wiedzy, którymi powinien zająć się Twój przewodnik. Pomocne może być:

• Przeprowadzaj ankiety
• Przejrzyj fora internetowe
• Poproś o opinię klientów

Dostosuj swój przewodnik do poziomu umiejętności i punktu widzenia odbiorców

Będziesz także chciał poznać komfort czytelników w związku z danym tematem. Różni odbiorcy mają różny poziom umiejętności. Doskonały przewodnik instruktażowy jest dostosowany do możliwości technicznych odbiorców docelowych, zarówno początkujących, jak i ekspertów.

Przejrzyj wyszukiwane hasła i opinie na temat istniejących materiałów szkoleniowych i edukacyjnych. Porozmawiaj ze swoim zespołem obsługi klienta, aby uzyskać wgląd w doświadczenia klientów. Zapoznaj się ze słowami kluczowymi, których używają Twoi odbiorcy – na przykład podczas wyszukiwań w Internecie. Jakiego języka używają do opisania tematu, swoich problemów lub punktów zamieszania?

Krok 2: Ustrukturyzuj swój przewodnik

„Łatwe jak 1-2-3” – twórz krok po kroku listy numerowane i wypunktowania

Nic więc dziwnego, że listy numerowane są łatwiejsze do zrozumienia niż gęsta ściana tekstu. Podziel swój przewodnik na osobne kroki lub łatwe do zarządzania fragmenty.

Pamiętaj, że w trakcie czytania odbiorcy mogą przełączać się między przewodnikiem a zadaniem. Numerowanie lub literowanie kroków pomaga widzom podążać za nimi.

Ściana tekstu? Następny!

Snagit ułatwia skuteczniejszą komunikację za pomocą materiałów wizualnych.

Dowiedz się więcej

Postępuj zgodnie z szablonem przewodnika

Jeśli Twoja organizacja tworzy wiele przewodników lub serię, rozważ użycie szablonu przewodnika. Spójne przewodniki zbudowane na podstawie tego samego szablonu pomagają czytelnikom wiedzieć, czego się spodziewać. Dzięki temu pisanie instrukcji i tworzenie przewodników jest znacznie szybsze i łatwiejsze dla innych osób w Twojej organizacji!

Rozważ na przykład umieszczenie w szablonie wprowadzenia, które pozwoli określić:

• Docelowa grupa odbiorców przewodnika.
• Cel przewodnika, czyli czego czytelnik może się spodziewać.
• Oprogramowanie, narzędzia lub zasoby potrzebne do ukończenia procesu.
• Informacje kontaktowe lub zasoby pomocy na wypadek, gdyby czytelnik wpadł w kłopoty.

Rozważ wniosek w swoim szablonie:

• Podsumowując cel lub cel przewodnika, co powinien teraz zrobić Twój czytelnik?
• Kolejne kroki lub dalsze przewodniki z serii
• Informacje kontaktowe lub zasoby pomocy

Koniecznie sprawdź gotowe, profesjonalnie zaprojektowane szablony Snagit. Mamy nawet kategorię szablonów „Kroki”, zaprojektowaną tak, aby zmieścić 2–6 kroków na jednej stronie. Szablony te można również modyfikować, aby w razie potrzeby dodać dodatkowe kroki na większej liczbie stron!

Krok 3: Napisz instrukcje krok po kroku

Twórz jasne i zwięzłe kroki

Teraz czas pisać!

Zamiast polegać na swojej pamięci (co prawda słabej), najpierw samodzielnie wykonuję zadanie, notując każdy krok. Szczególnie w przypadku znanych zadań, które wykonuję regularnie, ważne jest, aby obserwować potencjalne przeszkody dla nowych użytkowników.

Upewnij się, że język i terminy użyte w przewodniku są spójne z tym, co użytkownik widzi na ekranie.

Uważaj! Zadaj sobie pytanie, czy są punkty, w których to, co widzisz, może różnić się od tego, co widzą Twoi odbiorcy, lub w których kroki mogą się różnić. Czy jest możliwe, że Twój czytnik korzysta z innej wersji oprogramowania, systemu operacyjnego lub przeglądarki?

Dodaj obrazy

Wykonuję zrzuty ekranu lub zdjęcia w czasie rzeczywistym podczas wykonywania zadania.

Obrazy pomagają zilustrować krok lub zapewnić kontekst. Pomagają zapewnić, że Twój przewodnik będzie łatwy do zrozumienia i że odbiorcy będą mogli go śledzić niezależnie od poziomu umiejętności.

Dodawaj adnotacje do obrazów za pomocą strzałek, komentarzy lub etykiet. Tego typu elementy wizualne zapewniają, że czytelnik połączy tekst z obrazem.

Pamiętaj, aby usunąć ze zdjęć niepotrzebne szczegóły, które mogłyby zmylić lub odwrócić uwagę czytelnika od głównego punktu obrazu.

Pamiętasz odbiorców zidentyfikowanych w kroku 1 i ich poziom znajomości? Czy musisz wyjaśniać, gdzie można znaleźć każdy element na ekranie?

Pomocne może być na przykład polecenie komuś kliknięcia przycisku „Ustawienia” w celu wyjaśnienia, że ​​wygląda on jak koło zębate. Konieczne może być także podkreślenie lokalizacji łatwo przeoczonych ikon lub zduplikowanych elementów na ekranie.

Krok 4: Dodaj dodatkowe informacje i zasoby

Dołącz odpowiednie linki i zasoby

Jeśli zadanie udokumentowane w Twoim przewodniku wymaga dodatkowych zasobów lub można je uzupełnić, pamiętaj o ich uwzględnieniu. Mogą to być pliki źródłowe projektu lub łącza do powiązanych lub bardziej szczegółowych samouczków.

Może to obejmować łącza do pobierania innych produktów. Twój poradnik nie powinien być ukrytą stroną sprzedażową lub marketingową. Jeśli inne oprogramowanie lepiej odpowiada potrzebom odbiorców, zaoferuj wskazówki, zwłaszcza jeśli istnieją bezpłatne opcje.

Podaj kontekst i tło

Pomóż czytelnikom zrozumieć, dlaczego Twój przewodnik jest dla nich przydatny. Dołącz odpowiednie przykłady lub to, co powinni umieć zrobić po zastosowaniu się do przewodnika.

W przypadku złożonego procesu podanie podstawowych informacji w przewodniku może uzasadniać konieczność podjęcia określonych kroków. Ten dodatkowy kontekst może pomóc użytkownikom zrozumieć przyczynę procesu, zwłaszcza jeśli jest ona nieznana.

Dodawaj adnotacje i edytuj zrzuty ekranu za pomocą Snagit

Profesjonalne narzędzia do oznaczania i zaawansowane funkcje ułatwiają tworzenie przydatnych obrazów.

Wypróbuj za darmo

Krok 5: Przetestuj swój poradnik

Zapewnij dokładność i użyteczność

Po sporządzeniu pisemnej listy kroków wraz z towarzyszącymi ilustracjami przejrzyj swój przewodnik pod kątem dokładności:

• Czy pominąłeś jakieś kroki?
• Czy język jest spójny z tym, co zobaczą czytelnicy?
• W przypadku przewodników po oprogramowaniu upewnij się, że instrukcje są dokładne dla wszystkich wersji, z których mogą korzystać Twoi czytelnicy. Alternatywnie możesz określić konkretną wersję, której dotyczy problem, i podać informacje, gdzie można uzyskać pomoc dotyczącą innych wersji.

Poproszenie innej osoby o przejrzenie Twojego przewodnika – zwłaszcza kogoś niezaznajomionego z procesem – jest zawsze dobrym pomysłem. Ta osoba może to dla Ciebie przetestować, tak jak zrobiłby to prawdziwy nowy użytkownik. Jeśli są obszary, których nie jesteś pewien, czy są jasne, zaznacz te, które wymagają szczególnej uwagi recenzenta.

Ta osoba może pomóc w zapewnieniu, że Twoja dokumentacja jest nie tylko dokładna, ale także łatwa do przestrzegania:

• Czy język jest jasny i łatwy do zrozumienia?
• Czy istnieją zbyt skomplikowane kroki, które należy podzielić na dalsze części?
• Czy uwzględniono odpowiednie obrazy, aby zapewnić przejrzystość i kontekst?

Świadomość, że ktoś może znaleźć błędy lub zasugerować ulepszenia Twojej dokumentacji, może być niewygodna. Jednak prawdopodobieństwo, że Twoi czytelnicy odniosą sukces, będzie większe, jeśli w pełni wykorzystasz swój zespół do wykrycia potencjalnych problemów.

Jeśli nikt inny nie może przejrzeć przewodnika, przejrzyj go samodzielnie, aby sprawdzić dokładność i użyteczność. Poczekaj dzień lub dwa od zakończenia pisania poradnika, zanim go przejrzysz, zakładając, że nie dotrzymałeś terminu. Pomoże Ci to podejść do poradnika ze świeżej perspektywy, jakbyś był nowym użytkownikiem.

Wprowadzaj poprawki w oparciu o opinie

I oczywiście w razie potrzeby zmodyfikuj przewodnik na podstawie recenzji. Przygotuj się na otrzymanie informacji zwrotnej od odbiorców i bądź otwarty na powtarzanie swojego przewodnika, jeśli zajdzie taka potrzeba.

Krok 6: Opublikuj i rozpowszechnij swój przewodnik

Wybierz odpowiednią platformę

Kiedy nadejdzie czas opublikowania przewodnika, zastanów się nad najlepszą lokalizacją i metodą dystrybucji. Kilka rzeczy do rozważenia:

• Jeśli ta dokumentacja ma charakter wewnętrzny, ułatwienie jej znalezienia może znacząco poprawić produktywność.
• Jeśli Twój przewodnik jest skierowany do publiczności, czy należy go rozpowszechniać? Na przykład wysłane przez zespoły sprzedaży lub menedżerów ds. sukcesu klienta do nowych klientów?
• Lub, jeśli zostanie umieszczony w Twojej witrynie, w jaki sposób znajdą go docelowi odbiorcy?
• Jeśli planujesz szeroko udostępniać swój przewodnik, lepiej wysłać linki online, niż korzystać z plików PDF lub publikować w różnych miejscach. Zarządzaj przewodnikami w jednym miejscu, aby ułatwić aktualizacje i zapobiec rozpowszechnianiu się nieaktualnych wersji.
• Czy niektórzy z czytelników będą mieli pytania, uwagi lub wskazówki, które będą pomocne dla innych? Rozważ opublikowanie swojego przewodnika na platformie z wbudowanymi rozmowami, np. Screencast.

Optymalizuj pod kątem SEO

Jeśli zostanie opublikowany publicznie, w jaki sposób docelowi odbiorcy znajdą Twój przewodnik?

Upewnij się, że instrukcje odpowiadają treści wyświetlanej na ekranie. Sekcje opisowe Twojego przewodnika powinny, jeśli to możliwe, odzwierciedlać język czytelników.

Zbadanie odbiorców w kroku 1 pozwoli ci poznać ich język. Włącz to do swojego przewodnika, aby pomóc innym go znaleźć.

Rozważ użycie narzędzi do optymalizacji SEO, takich jak SEMrush lub wtyczka Yoast do WordPress. Poprawa SEO poprawia możliwość znalezienia treści w razie potrzeby.

Podsumowanie: Najlepsze praktyki dotyczące pisania praktycznego poradnika

Używaj prostego, bezpośredniego języka

Najważniejszą częścią oceny praktycznego poradnika jest określenie, czy łatwo jest go zastosować. Używaj prostego, bezpośredniego języka, który użytkownicy będą mogli zrozumieć, niezależnie od ich poziomu umiejętności.

Dołącz obrazy, aby wyjaśnić każdy krok

Pomóż uniknąć zamieszania wśród czytelników. Pokaż, co masz na myśli, za pomocą zrzutu ekranu lub zdjęcia z adnotacjami dla każdego kroku.

Regularnie aktualizuj swój przewodnik

Upewnij się, że Twój przewodnik jest dokładny, regularnie go przeglądając i aktualizując. Jeśli aktualizacje są dostępne online, pomagają również poprawić SEO i ranking.

Ważna część: Ułatw sobie to zadanie

Nie pozwól, aby stworzenie poradnika trwało dłużej niż samo szkolenie!

Użyj Snagit, lidera rynku oprogramowania do przechwytywania ekranu. Spodoba Ci się kompleksowe rozwiązanie do przechwytywania ekranu, tworzenia GIF-ów, adnotacji, szablonów i elastycznych opcji eksportu.

Przestań powtarzać pytania

Twórz przejrzyste filmy i przewodniki za pomocą Snagit, dzięki czemu będziesz musiał wyjaśniać zadania tylko raz.

Wypróbuj za darmo