Tworzenie skutecznych retorycznie instrukcji obsługi

Instrukcje obsługi

Wiele osób kojarzy instrukcje obsługi z urządzeniami AGD, akcesoriami komputerowymi i produktami wymagającymi montażu (np. meblami). Ponieważ nie korzystamy z nich regularnie lub spodziewamy się ich tylko w pewnych kontekstach, łatwo jest zapomnieć, jak ważne są. Jakość dobrze zaprojektowanej instrukcji obsługi może pozostać niezauważona. Jednak, gdy napotykamy frustrację przy składaniu półki z książkami lub zabawki, lub gdy próbujemy dowiedzieć się, jak zmienić lub aktywować konkretne ustawienie urządzenia, znaczenie dobrze zaprojektowanej instrukcji staje się jasne.

Understanding the Rhetorical Situation of Instruction Manuals

Instruction manuals, like other types of texts, are shaped by a rhetorical situation. Wybory dokonywane przez pisarzy technicznych w odniesieniu do treści i formy zależą od celu instrukcji obsługi, zamierzonego odbiorcy i kontekstu, w którym instrukcja jest używana. Podczas pisania własnej instrukcji obsługi, rozważ następujące pomysły i pytania dotyczące sytuacji retorycznej.

Cel

Ogólnie, celem instrukcji obsługi jest zapoznanie użytkownika z produktem i/lub przeprowadzenie go przez serię kroków, które prowadzą do wykonania zadania. Jednak każda instrukcja obsługi będzie miała również bardziej specyficzny rezultat. Określenie, jaki jest ten konkretny wynik, pomoże Ci podjąć bardziej efektywne decyzje retoryczne dotyczące treści i projektu. Zadaj sobie pytanie:

Jaki jest konkretny zamierzony wynik(y) instrukcji? (np. upieczenie ciasta od podstaw, zainstalowanie klimatyzatora itp.)
Czy oprócz pomocy użytkownikom w osiągnięciu głównego pożądanego wyniku (wyników), istnieją inne cele, którym służy instrukcja? (np. oferowanie porad dotyczących rozwiązywania problemów, uczenie użytkowników, jak wykonać dodatkowe, proste zadania niezbędne do osiągnięcia głównego celu)

Zbiorowość

Określenie profilu odbiorców (tj. pierwotnego użytkownika dokumentu) jest niezbędne do dokonania przemyślanych wyborów dotyczących zakresu, treści i projektu. Przed przystąpieniem do pisania należy rozważyć następujące pytania dotyczące odbiorców:

Jaka jest wiedza lub doświadczenie odbiorców w zakresie tematu instrukcji obsługi?
Jaki jest ogólny poziom komfortu odbiorców w zakresie uczenia się nowych umiejętności związanych z oprogramowaniem, aplikacjami, przepisami itp. W jaki sposób Twoja instrukcja obsługi będzie adresować styl uczenia się, cele i potrzeby związane z zadaniami odbiorców?

Kontekst

Myśl o kontekście jako o sytuacji czasowej, społecznej, technologicznej i kulturowej otaczającej tworzenie i używanie instrukcji obsługi. Poniższe pytania pomogą Ci zidentyfikować kontekst:

Ile czasu będziesz miał na ukończenie tej instrukcji obsługi?
Czy użytkownik ma ograniczenia czasowe?
Jakie ograniczenia technologiczne musisz wziąć pod uwagę przy tworzeniu instrukcji obsługi? Weź pod uwagę swoje umiejętności w zakresie technologii i poziom dostępu.
Jak Twoi odbiorcy uzyskają dostęp do podręcznika? (np., słuchacze mogą uzyskać dostęp do podręcznika online za pośrednictwem witryny internetowej firmy)
Jakie dodatkowe narzędzia lub materiały zakładasz, że słuchacze już posiadają? Czy będą mieli dostęp do technologii lub materiałów potrzebnych do wykonania instrukcji? (np., aby z powodzeniem zbudować półkę na książki, użytkownik będzie potrzebował młotka, śrubokrętu i otwartej przestrzeni roboczej)
Z jakiej perspektywy kulturowej piszesz instrukcję obsługi? Czy odbiorcy będą dzielić ten sam kontekst kulturowy? (np. niemiecki przepis, który wymaga cukru waniliowego, składnika trudno dostępnego w Stanach Zjednoczonych, może wymagać modyfikacji dla amerykańskich użytkowników)

Używanie wiedzy o sytuacji retorycznej do dokonywania skutecznych wyborów retorycznych

Chociaż większość instrukcji obsługi opiera się na pewnych standardowych konwencjach, każda instrukcja obsługi powinna być dostosowana do osiągnięcia konkretnego celu dla konkretnego odbiorcy w danym kontekście. Poniższy rozdział przedstawia niektóre wspólne cechy instrukcji obsługi, biorąc jednocześnie pod uwagę sytuację retoryczną i to, w jaki sposób może ona wymagać odstępstwa od pewnych konwencji.

Zakres

Sytuacja retoryczna pomaga określić ilość szczegółów, które należy zawrzeć w instrukcji obsługi. Na przykład, zakres instrukcji montażu biurka jest łatwy do określenia, ponieważ ma tylko jeden rezultat: złożenie biurka. Jednak instrukcja obsługi aparatu Digital Single Lens Reflex (DSLR) może być napisana zarówno dla amatorów, jak i bardziej doświadczonych użytkowników aparatu i może wymagać uwzględnienia instrukcji dotyczących wykonywania podstawowych zadań (np. instalowania baterii i karty pamięci), jak również bardziej zaawansowanych zadań (np, dostosowywanie ustawień do określonych warunków fotografowania).

Zawartość

Niektóre standardowe sekcje instrukcji obsługi obejmują część przednią, wprowadzenie, serię kroków, zakończenie i część tylną, chociaż niektóre instrukcje mogą nie wykorzystywać wszystkich tych sekcji lub oznaczać je w ten sposób. Na przykład obszerny przód i tył można często znaleźć w dłuższych, bardziej złożonych instrukcjach. Większość zestawów instrukcji zawiera jednak wstęp, który dostarcza informacji niezbędnych do bezpiecznego i efektywnego wykonania poszczególnych czynności. Wstęp może zawierać wyjaśnienie, kto powinien wykonać zadanie (być może użytkownik musi mieć biegłość w jakiejś umiejętności), potrzebne materiały, wszelkie środki ostrożności, które użytkownik powinien podjąć (wskazówki bezpieczeństwa lub inne ostrzeżenia), a w niektórych przypadkach oszacowanie, ile czasu zajmie proces (częsta cecha przepisów kulinarnych). W niektórych przypadkach konieczne jest zamieszczenie wyjaśnienia, dlaczego użytkownik powinien postępować zgodnie z instrukcją. Na przykład, instrukcja wymiany oleju w samochodzie może wyjaśniać, dlaczego zadanie to jest konieczne do prawidłowego funkcjonowania pojazdu.

Po tym materiale wprowadzającym następuje sekwencja instrukcji krok po kroku. Zobacz następującą sekcję „Język”, aby dowiedzieć się, jak opracować jasne i skuteczne kroki. Wreszcie, instrukcja może zawierać „Przewodnik rozwiązywania problemów” lub sekcję „Porady”, aby pomóc użytkownikom w rozwiązywaniu typowych problemów, które mogą napotkać podczas wykonywania instrukcji lub po zakończeniu procesu.

Język

Pytania dotyczące „Publiczności” i „Kontekstu” powyżej mogą pomóc w dokonaniu skutecznych wyborów językowych. Poniższe podrozdziały zawierają wyjaśnienia typowych cech językowych instrukcji obsługi wraz ze wskazówkami, jak pisać jasno i zwięźle w tym gatunku.

Trójkąt imperatywny

Instrukcje, podobnie jak polecenia, często używają trybu imperatywnego. Aby pisać w ten sposób, należy zwracać się bezpośrednio do odbiorców, używając głosu czynnego i konkretnych czasowników. Które z poniższych zdań stanowi najbardziej zrozumiałą instrukcję?

„Naciśnij czerwony przycisk, aby rozpocząć grę”
„Po naciśnięciu czerwonego przycisku gra się rozpocznie”
„Operator powinien nacisnąć przycisk”

Chociaż użytkownik mógłby prawdopodobnie zrozumieć każde z tych zdań, pierwsze z nich stanowi najbardziej zrozumiałe wyjaśnienie czynności, którą powinien wykonać użytkownik. Druga, pasywna konstrukcja nie określa, kto powinien nacisnąć przycisk. Trzeci przykład odnosi się do niejasnego podmiotu, „operatora”, co może zdezorientować użytkownika.

Dobór słów

Podczas pisania instrukcji, staranne rozważenie doboru słów jest ważne, ponieważ w niektórych przypadkach, bezpieczeństwo użytkownika jest zagrożone. Z tego powodu należy dążyć do jasności i zwięzłości. Aby skutecznie podejmować decyzje dotyczące doboru słów, należy wziąć pod uwagę poziom wiedzy i zaplecze kulturowe głównego odbiorcy. Może okazać się konieczne

zdefiniowanie złożonych terminów.
wypisz akronimy przy pierwszym ich wprowadzeniu (np, cyfrowa lustrzanka jednoobiektywowa, DSLR).
unikanie stosowania porównań, metafor, slangu lub substytutów, które mogą dezorientować użytkowników.
używanie prostego języka, ponieważ w niektórych przypadkach mogą wystąpić poważne konsekwencje prawne, gdy zestaw instrukcji jest niejasny. Aby uzyskać więcej informacji na temat prostego języka, zobacz http://www.plainlanguage.gov/index.cfm
załącz tłumaczenia instrukcji na wiele języków.
stosuj krótkie i informacyjne nagłówki i podtytuły

Spójność i paralelizm

Struktura równoległa, lub paralelizm, oznacza użycie tej samej struktury gramatycznej do przedstawienia informacji lub idei. Paralelizm jest często używany do poprawy czytelności i tworzenia spójności.

Ta numeryczna lista instrukcji zawiera krok, który łamie strukturę równoległą. Który z tych kroków wydaje się inny od pozostałych?

Odkręć śrubę, aby otworzyć komorę baterii.
Włóż baterie, postępując zgodnie z obrazkiem na komorze baterii.
Teraz możesz zamknąć komorę i przykręcić śrubę.

Krok trzeci łamie strukturę równoległą listy, ponieważ nie zaczyna się od czasownika dyrektywnego.

Czy poniższe nagłówki używają struktury równoległej? Dlaczego lub dlaczego nie?

„Instalowanie baterii”
„Wyłączanie/włączanie urządzenia”
„Jak ładować urządzenie”

Projektowanie

Projektowanie dokumentu odnosi się do sposobu organizacji i prezentacji informacji. Ponieważ wizualizacje wymagają mniej czasu na przetworzenie, użytkownicy zazwyczaj zauważają – i reagują na nie – jakość projektu przed jakością treści. Nawet jeśli nie zdecydujesz się na umieszczenie obrazów lub grafiki, będziesz musiał wziąć pod uwagę projekt. Minimalnie, obejmuje to dokonywanie wyborów dotyczących układu, kolejności informacji, rozmiaru czcionki, kroju pisma, nagłówków, koloru i białej przestrzeni. Elementy projektu powinny prowadzić użytkownika przez podręcznik w sposób płynny. Oznacza to, że dokument powinien być skanowalny; dokument skanowalny pozwala użytkownikom na nawigowanie po treści w celu znalezienia konkretnych informacji. Jak w przypadku każdego dokumentu, decyzje dotyczące projektu powinny uwzględniać odbiorców, cel i ogólną łatwość użycia.

Skonsekwencja/odtwarzanie

Użycie elementu projektu w jednolity sposób w całym dokumencie prowadzi użytkowników, dając im poczucie, czego mogą się spodziewać (np. ten sam krój i rozmiar czcionki dla wszystkich nagłówków; ten sam układ ze strony na stronę).

Kontrast

Użycie elementu projektu w celu podkreślenia specyficznych informacji lub cech podręcznika (np. kapitalizacja słowa dla podkreślenia; umieszczenie ramki lub obramowania wokół elementu; zmiana kolorów dla podkreślenia). Kontrast jest skuteczny przede wszystkim wtedy, gdy dokument jest ogólnie spójny. Jeśli brakuje spójności, trudniej jest stworzyć kontrast.

Wyrównanie

Organizowanie elementów na stronie za pomocą wyrównania poziomego i/lub pionowego tworzy hierarchię i strukturę, i może być użyte, aby pomóc osiągnąć równowagę, kontrast lub spójność. Na przykład, ten dokument używa pionowego wyrównania, aby stworzyć hierarchię między nazwą elementu projektu, która jest wyrównana do lewej, a jego opisem, który jest wcięty.

Równowaga

Rozłożenie elementów równomiernie na danej przestrzeni. Aby to osiągnąć, należy wziąć pod uwagę wagę każdego elementu, czyli tendencję oka do przyciągania się w kierunku danego elementu. Na przykład, ponieważ obraz waży więcej niż tekst, decyzje dotyczące umieszczenia obrazu powinny uwzględniać sposób zrównoważenia jego wagi w stosunku do innych elementów w celu uniknięcia wizualnego zamieszania.

Biała przestrzeń

Używanie białej przestrzeni w celu stworzenia profesjonalnego, zrównoważonego dokumentu. Zamiast wskazywać kolor przestrzeni, ten element projektu odnosi się do braku obrazów i tekstu. Biała przestrzeń pomaga rozróżnić poszczególne elementy i grupy elementów (np. sekcje podręcznika) oraz ułatwia skanowanie dokumentów.

Grupowanie/bliskość

Umieszczanie powiązanych obrazów lub treści blisko siebie. Na przykład zgrupowanie obrazów wszystkich materiałów potrzebnych do wykonania danego zadania.

Kolor

Wybór kolorów w celu stworzenia kontrastu i podkreślenia, poprowadzenia czytelnika przez przestrzeń oraz zaprojektowania dokumentu przyjemnego wizualnie. Aby stworzyć spójny schemat kolorów, należy wziąć pod uwagę całość dokumentu. Na przykład, jeśli chcesz użyć niebieskiego w swoim dokumencie, będziesz chciał się upewnić, że jest on używany konsekwentnie i uzupełnia inne kolory dokumentu. Jest to szczególnie ważne przy integrowaniu kolorowej grafiki i/lub obrazów.

Obrazy

Wybór odpowiednich obrazów dla danego kontekstu i celu podręcznika. Należy rozważyć, czy obrazy mają być samodzielne, czy mają uzupełniać instrukcje pisemne. Należy rozważyć rodzaje obrazów, takie jak rysunki, zdjęcia i ilustracje graficzne, a także to, czy potrzebne są dodatkowe wyróżnienia lub adnotacje w celu podkreślenia określonych części obrazu. Obrazy powinny być tak dobrane, aby uzupełniały inne elementy projektu w podręczniku.

Wniosek

Dobry podręcznik instruktażowy zaczyna się od dokładnego rozważenia sytuacji retorycznej – celu, odbiorców i kontekstu. Ta informacja jest kluczem do dokonania odpowiednich i skutecznych wyborów dotyczących treści, języka i projektu. W idealnym układzie czasowym, autorzy techniczni mają możliwość przeprowadzenia testów użyteczności, których celem jest ocena, jak dobrze dokument spełnia swoje zadanie. Kiedy instrukcja zostanie przetestowana, wykorzystasz otrzymane informacje zwrotne, aby sfinalizować jej projekt i zawartość.

Ćwiczenie 1 – Zapoznaj się z instrukcjami

Następująca strona internetowa zawiera kilka przykładów instrukcji open-source. Kliknij na ten link, przejrzyj listę i wybierz jedną instrukcję, której chcesz się bliżej przyjrzeć. Przejrzyj instrukcję, aby zapoznać się z jej treścią i wyglądem. Następnie, w notatce do swojego instruktora lub kolegów z klasy, zajmij się następującymi kwestiami.

Zidentyfikuj sytuację retoryczną

Kim jest publiczność? Skąd wiesz, kim jest publiczność? Co możesz założyć o publiczności na podstawie treści i wyborów projektowych w podręczniku?
Jaki jest cel dokumentu? Skąd wiesz, że jest to główny cel (tj. jakie wybory dotyczące treści i projektu sygnalizują ten cel)?
Jaki kontekst informuje o treści pisemnej i projekcie tego podręcznika?

Badaj wybory dotyczące kompozycji

Opisz ogólny zakres i organizację podręcznika. Jak szczegółowy jest podręcznik? Co obejmuje? Jak zorganizowane są informacje?
Czy wszystkie „standardowe cechy” treści zostały uwzględnione w tym podręczniku? Dlaczego lub dlaczego nie? Czy istnieją dodatkowe funkcje? Jakie one są i jaki jest ich cel(e)?
Znajdź i opisz przykłady skutecznego doboru języka. Wyjaśnij, dlaczego uważasz je za skuteczne.
Zlokalizuj i opisz przykłady efektywnego projektowania. Wyjaśnij, dlaczego uważasz je za skuteczne.
Gdybyś był autorem tego podręcznika, co zrobiłbyś inaczej i dlaczego?

Ćwiczenie 2 – Planowanie podręcznika instruktażowego

Wyobraź sobie, że piszesz podręcznik instruktażowy dla procesu lub produktu, który znasz i odpowiedz na następujące podpowiedzi.