Jak tworzyć instrukcje krok po kroku za pomocą wizualizacji

Istnieje kilka samouczków, których zrozumienie przez czytelników wymaga czegoś więcej niż tylko tekstu. Tworząc instrukcje krok po kroku za pomocą wizualizacji, możesz wprowadzić czytelników w szczegóły, które w innym przypadku mogłyby nie zostać przekazane. Te wizualizacje mogą być nieruchomymi obrazami lub zrzutami ekranu, animowanymi GIF-ami, wykresami porównawczymi lub filmami. Oprócz pomagania czytelnikom w zrozumieniu treści, wizualizacje przełamują również monotonię dużej ilości tekstu.

W zeszłym roku pracowałem jako pisarz techniczny dla instrukcji pisania Joyent i tworzenia filmów skierowanych do użytkowników na wszystkich poziomach umiejętności. Wymaga to precyzji — ludzie liczą na mnie przy tworzeniu instrukcji krok po kroku i przewodników do zadania technicznego. Jeśli przegapię krok lub założę, że czytelnicy już znają jakąś informację, mogą odejść sfrustrowani i nigdy nie wrócić do naszych treści. Z drugiej strony, jeśli będę zbyt szczegółowy, zawartość może wydawać się przesadna i chaotyczna, a także wymagać częstszych aktualizacji. Brak ciśnienia.

Znalezienie miejsc, w których obraz może zastąpić niektóre z tych zbyt precyzyjnych szczegółów, oszczędza czas i energię. Ponadto czytelnicy odchodzą, wiedząc, czego oczekują, co, miejmy nadzieję, ułatwi im życie. Jeśli to możliwe, postępuj zgodnie z kilkoma kluczowymi radami dotyczącymi pisania: pokaż, nie mów (tak ważne, że ma własną stronę w Wikipedii).

Nie musisz być pisarzem technicznym, aby korzystać z precyzyjnego żargonu procesowego. Czytaj dalej, aby poznać strategie przygotowywania instrukcji i dodawania elementów wizualnych do dowolnego dokumentu.

Zanim zaczniesz wizualizować, rozważ swoich odbiorców

Zanim zaczniesz tworzyć treści, powinieneś wiedzieć, dla kogo je produkujesz i jakie są ich oczekiwania. Chociaż niemożliwe jest przewidzenie indywidualnych potrzeb każdego czytelnika, zasady, które ustalasz, wpływają na ton treści i mogą pomóc w podejmowaniu decyzji na późniejszym etapie tworzenia zarysu procesu.

Rozważ następujące:

• Czy moi czytelnicy są już ekspertami? Czy robili ten proces wcześniej, jeśli nie dokładnie to w podobnych okolicznościach?
• Czy moi czytelnicy są wewnętrzni czy zewnętrzni? Jeśli moi czytelnicy są w tej samej firmie, w jakim języku posługujemy się, aby lepiej wyjaśnić proces?
• W jakim nastroju będą mnie zadowalać? Czy tworzę tę treść dla kogoś, kto się spieszy, aby coś zrobić, czy jest to dla bardziej swobodnej osoby uczącej się, która ma tylko nadzieję na dalszą edukację na dany temat?
• Co jest najważniejsze dla moich czytelników? Co jest najmniej ważne?
• Jak moi czytelnicy wolą się uczyć? Czy wiem, czy post na blogu jest bardziej udany niż film? Czy są jakieś dane analityczne na poparcie tych twierdzeń?
• Czy moi czytelnicy są rodzimymi użytkownikami języka angielskiego? Jeśli użyję idiomu, czy przeszkodzi to w nauczeniu się, jak ukończyć proces?

Bez względu na to, co tworzysz, zawsze tworzysz to z czytelnikiem po drugiej stronie. Im lepiej znasz swojego czytelnika i tworzysz treści z myślą o nim, tym większe prawdopodobieństwo, że będą wracać po więcej treści.

Opisz proces, podając tylko tyle szczegółów, ile jest to konieczne

Jednym ze sposobów przygotowania procesu lub samouczka dla dowolnego medium jest rozpoczęcie od dwukolumnowej tabeli. Pierwsza kolumna będzie zawierała każdy indywidualny krok, który czytelnik musi wykonać, aby wykonać zadanie. Te kroki mogą być tak małe i precyzyjne, jak „prześlij zgłoszenie” lub tak duże i nieprecyzyjne, jak „wypełnij pozostałą część formularza”.

Druga kolumna będzie kolumną procesu wizualnego. Na początku może nie zawierać żadnych rzeczywistych wizualizacji, ale opis tego, jakie będą wizualizacje. Jeśli tworzysz pisemny dokument, nie musisz mieć dopasowanej wizualizacji dla każdego kroku w kolumnie pierwszej. Jeśli będziesz tworzyć screencast, każde pudełko powinno zawierać notatkę o rodzaju wizualizacji, która ma zostać dołączona. W filmie nie powinno być zbyt wiele czasu na pustym ekranie.

Przykład tej tabeli znajduje się poniżej w sekcji „Przykładowy zarys”, ale najpierw musisz dowiedzieć się więcej o rodzajach pomocy wizualnych.

Rodzaje wizualizacji i kiedy ich używać

Każdy proces może skorzystać z różnych rodzajów wizualizacji. Medium zmieni się w zależności od przeznaczenia.

• Obrazy nieruchome – jest to idealne medium do wizualizacji fizycznego produktu, czy to osoby, czy konkretnego przedmiotu, takiego jak rodzaj patelni. Mogą to być zdjęcia stockowe lub wykonane przez Ciebie.
• Zrzut ekranu — nieruchomy obraz ekranu jest świetny, gdy mówimy o produktach wyświetlanych na komputerze, takich jak witryna internetowa lub inne oprogramowanie. Są bardzo łatwe do zrobienia i edycji, szczególnie dzięki Snagit.
• GIF – animowane obrazy są idealne do wyjaśniania krótkich procesów (poniżej 8 sekund), które mogą nie być tak łatwo wyartykułowane.
• Wykres – wykresy słupkowe, kołowe, liniowe, tak wiele rodzajów wykresów! Wykres jest najlepszym wyborem, gdy mówimy o zestawie liczb i porównujemy go.
• Wideo — doskonały obraz, wideo świetnie nadaje się do wyjaśnienia procesu. Jak zrobić świetne wideo techniczne to forma sztuki, której ten proces z pewnością może pomóc, ale wymaga znacznie więcej planowania. (Na szczęście dla ciebie, wiele się nauczyłem od TechSmith i mają dużo więcej do powiedzenia na ten temat).

Zachęcamy do korzystania z mieszanki mediów w swoim pisaniu. Każdy zaspokoi różne potrzeby na różnych etapach.

Przykładowy zarys

Przepisy są jednym z najlepszych przykładów procesu, który często wymaga precyzji, w którym efekty wizualne mogą mieć ogromne znaczenie. Powiedzmy, że chcę nakreślić instrukcje dotyczące robienia ciasta:

Tabela {

border-collapse: zwiń;

}

tabela, td, th {

obramowanie: 1px stałe #404040;

dopełnienie:4px;

}

Gdyby każdy krok miał obraz, byłoby to trochę… nieuzasadnione.

Wybierz swoje wizualizacje

Wybrane przeze mnie obrazy są pomocne w artykułowaniu miniprocesów w ramach większego procesu. W szczególności obraz w kroku 7 mieszanego do tej pory mieszanki jest kluczowym dowodem wizualnym. Po upieczeniu kilku ciast z tą instrukcją, różnica między w sam raz, a przemieszanym… Żałuję, że nie mam zdjęcia. Mogłaby istnieć instrukcja obsługi napisana tylko o zawiłościach tego, jak długo mieszać — każda inna strona musiałaby być obrazem.

Po określeniu potrzebnych wizualizacji musisz zebrać towary. W tym przykładzie najlepiej byłoby zrobić zdjęcia procesu pieczenia ciasta. W przypadku innych procesów może nie być konieczne robienie niestandardowych zdjęć. Istnieje wiele bezpłatnych i płatnych witryn z fotografiami stockowe, które zawierają filmy, GIF-y i zdjęcia do wykorzystania według własnego uznania.

Testowanie z grupą docelową

Żaden tekst nie jest kompletny, dopóki nie zostanie przeczytany przez kogoś z grupy docelowej i otrzyma aprobatę. Ich wkład pokaże, gdzie przegapiłeś etap procesu lub gdzie potrzebne są więcej wizualizacji.

Najłatwiejszym sposobem na to (bez dużych zasobów zespołu ds. użyteczności) jest poproszenie kilku osób z Twojej kluczowej grupy demograficznej, aby przeczytały Twoją treść i spróbowały postępować zgodnie z procesem dokładnie tak, jak napisano. Często cytowany jest Jakob Nielsen, który mówi, że pięć to najlepsza liczba osób do wyłapania największej liczby problemów.

Testy niemoderowane

Testowanie niemoderowane jest idealne w przypadku mniejszych projektów o ograniczonych zasobach — lub po prostu wtedy, gdy potrzebujesz szybkich wyników. Istnieje wiele narzędzi, których możesz użyć, aby uzyskać dokładniejsze wyniki, ale jeśli szukasz informacji zwrotnej na temat mniejszego procesu, możesz uciec od wysłania dokumentu do testerów z zestawem pytań, które chcesz odpowiedział.

Poproś testerów, aby robili notatki za każdym razem, gdy mają pytania, widzą coś, czego może brakować, natrafiają na przeszkody w tym procesie lub żałują, że nie mają bardziej szczegółowych instrukcji. Miejmy nadzieję, że uda im się dokończyć zadanie, zanim udzielą Ci opinii.

Testy moderowane

Największą zaletą testowania moderowanego jest to, że możesz obserwować, jak tester wykonuje proces i zobaczyć, gdzie jest zdezorientowany, zamiast polegać na nim, aby zauważyć to zamieszanie za Ciebie. Jeszcze lepiej, jeśli nagrasz sesję, aby nie polegać wyłącznie na notatkach, które robisz podczas tej sesji.

Po drodze zadawaj pytania. Na przykład:

• Czy rozumiesz, o jakie zadanie zostałeś poproszony? Czy to zadanie miało sens?
• Co ułatwiłoby ukończenie tego procesu?
• Jeśli była wizualizacja z krokiem, czy wizualizacja pomogła ci zrozumieć, co robić?
• Czy chciałbyś, żeby było więcej wizualizacji?

Zawijanie

Teraz już wiesz, dlaczego powinieneś dodawać elementy wizualne do instrukcji krok po kroku i masz arsenał narzędzi, które pomogą Ci skutecznie tworzyć instrukcje krok po kroku za pomocą pomocy wizualnych. Praktyka czyni mistrza. Twoja pierwsza próba dodania obrazów do procesu może nie być idealna, ale dzięki testom użytkowników, które pokierują procesem edycji, będziesz na dobrej drodze, aby pomóc użytkownikom zrozumieć, jak wykonać zadanie.

Czy masz inną metodę, aby dowiedzieć się, kiedy dodać pomoce wizualne do instrukcji? Podziel się wskazówkami w komentarzach poniżej!

Uwaga redaktora: Ten post został pierwotnie opublikowany w listopadzie 2017 r. i został zaktualizowany pod kątem dokładności i kompleksowości.