Instrukcje

Skupić się na tym rozdziale jest jednym z najważniejszych ze wszystkich zastosowań pisma technicznego-instrukcje. Jak wiadomo, instrukcje to objaśnienia krok po kroku, jak coś zrobić: jak zbudować, obsługiwać, naprawiać lub konserwować rzeczy.

Zapewnij się, aby sprawdzić przykłady.

Pisanie instrukcji

Jednym z najbardziej powszechnych i jednym z najważniejszych zastosowań pisma technicznego są instrukcje – objaśnienia krok po kroku, jak coś zrobić: zmontować coś, obsługiwać coś, naprawić coś lub wykonać rutynową konserwację czegoś. Ale dla czegoś, co wydaje się tak proste i intuicyjne, instrukcje są jednymi z najgorzej napisanych dokumentów, jakie można znaleźć. Podobnie jak ja, prawdopodobnie miałeś wiele irytujących doświadczeń ze źle napisanymi instrukcjami. To, co znajduje się w tym rozdziale, nie jest może niezawodnym i odpornym na błędy przewodnikiem pisania instrukcji, ale pokaże Ci, co profesjonaliści uważają za najlepsze techniki.

Ostatecznie, dobre pisanie instrukcji wymaga:

• Jasnego, prostego pisania
• Dokładnego zrozumienia procedury we wszystkich jej technicznych szczegółach
• Twojej zdolności postawienia się na miejscu czytelnika, osoby próbującej skorzystać z twojej instrukcji
• Twojej zdolności do bardzo szczegółowej wizualizacji procedury i uchwycenia tej świadomości na papierze
• Wreszcie, twojej gotowości do przejścia tego dodatkowego dystansu i przetestowania instrukcji na osobie, dla której je napisałeś.

Do tej pory prawdopodobnie studiowałeś nagłówki, listy i uwagi specjalne – pisanie zestawu instrukcji przy użyciu tych narzędzi prawdopodobnie wydaje się oczywiste. Po prostu podziel dyskusję na numerowane listy pionowe, wrzuć kilka uwag specjalnych w oczywistych miejscach i gotowe! Cóż, nie do końca, ale to świetny początek. Ten rozdział omawia niektóre cechy instrukcji, które mogą uczynić je bardziej złożonymi. Możesz z kolei wykorzystać te rozważania do zaplanowania własnych instrukcji.

Kilka wstępów

Na początku projektu pisania instrukcji ważne jest określenie struktury lub cech charakterystycznych konkretnej procedury, o której zamierzasz pisać.

Grupa odbiorców i sytuacja. Na wczesnym etapie procesu zdefiniuj grupę odbiorców i sytuację, w jakiej będą się znajdować Twoje instrukcje. Pamiętaj, że zdefiniowanie publiczności oznacza określenie jej poziomu znajomości tematu, a także innych tego typu szczegółów. Zobacz dyskusję na temat publiczności i kroków do wykorzystania w definiowaniu publiczności.

Najważniejsze, jeśli jesteś na kursie pisania, będziesz musiał napisać opis swojej publiczności i dołączyć go do instrukcji. Pozwoli to Twojemu instruktorowi ocenić Twoje instrukcje pod względem ich przydatności dla zamierzonej grupy odbiorców. Pamiętaj też, że na kursie pisania technicznego preferowane jest pisanie dla odbiorców niebędących specjalistami – to znacznie większe wyzwanie dla Ciebie jako pisarza.

Liczba zadań. Ile zadań jest w procedurze, o której piszesz? Użyjmy terminu procedura, aby odnieść się do całego zestawu czynności, które twoja instrukcja ma omówić. Zadanie to częściowo niezależna grupa czynności w ramach procedury: na przykład ustawienie zegara w kuchence mikrofalowej to jedno zadanie w dużej, ogólnej procedurze obsługi kuchenki mikrofalowej.

Prosta procedura, taka jak wymiana oleju w samochodzie, zawiera tylko jedno zadanie; nie ma pół-niezależnych grup czynności. Bardziej złożona procedura, taka jak używanie kuchenki mikrofalowej, zawiera mnóstwo takich częściowo niezależnych zadań: ustawianie zegara; ustawianie poziomu mocy; używanie timera; czyszczenie i konserwacja mikrofalówki, między innymi. (Instrukcje dotyczące korzystania z aparatu fotograficznego są zorganizowane według zadań.)

Niektóre instrukcje mają tylko jedno zadanie, ale mają wiele kroków w ramach tego jednego zadania. Na przykład, wyobraź sobie zestaw instrukcji do montażu zestawu huśtawek dla dzieci. W moim własnym doświadczeniu, było tam ponad 130 kroków! To może być trochę zniechęcające. Dobrym podejściem jest pogrupowanie podobnych i powiązanych kroków w fazy i rozpoczęcie przenumerowywania kroków w każdej nowej fazie. Faza jest wtedy grupą podobnych kroków w ramach procedury pojedynczego zadania. W przykładzie z huśtawką, ustawienie ramy byłoby fazą; zakotwiczenie rzeczy w ziemi byłoby kolejną; montaż huśtawki pudełkowej byłby jeszcze inną.

Najlepsze podejście do dyskusji krok po kroku. Inną kwestią, której być może nie możesz określić na początku, jest to, jak skoncentrować swoje instrukcje. Dla większości instrukcji, możesz skupić się na zadaniach, lub możesz skupić się na narzędziach (lub cechach narzędzi).

W podejściu zadaniowym (znanym również jako orientacja na zadanie) do instrukcji na temat korzystania z usługi odbierania telefonów, będziesz miał te sekcje:

• nagrywanie powitania
• odtwarzanie wiadomości
• zapisywanie wiadomości
• przesyłanie dalej wiadomości
• usuwanie wiadomości, i tak dalej

To są zadania – typowe rzeczy, które chcielibyśmy zrobić z automatem. Dalsza dyskusja na ten temat znajduje się w rozdziale o analizie zadań.

Z drugiej strony, w podejściu narzędziowym do instrukcji obsługi kserokopiarki, byłyby te mało prawdopodobne sekcje:

• przycisk kopiowania
• przycisk anulowania
• przycisk powiększania/zmniejszania
• przycisk kolportażu/zszywania
• przycisk kopiowania rozmiaru, i tak dalej

Jeśli zaprojektowałbyś zestaw instrukcji na tym planie, napisałbyś kroki do użycia każdego przycisku lub funkcji kserokopiarki. Instrukcje wykorzystujące to podejście do narzędzi są trudne do wykonania. Czasem nazwa przycisku nie do końca pasuje do zadania, z którym jest związany; czasem trzeba użyć więcej niż tylko jednego przycisku, aby wykonać zadanie. Mimo to może się zdarzyć, że podejście typu narzędzia/funkcje będzie lepsze.

Grupowanie zadań. Wymienienie zadań może nie być wszystkim, co trzeba zrobić. Może być tak wiele zadań, że musisz je pogrupować, aby czytelnicy mogli łatwiej znaleźć poszczególne z nich. Na przykład, w instrukcjach często spotykane są następujące grupy zadań:

1. rozpakowanie i zadania konfiguracyjne
2. zadania instalacyjne i dostosowawcze
3. podstawowe zadania operacyjne
4. rutynowe zadania konserwacyjne
5. zadania związane z rozwiązywaniem problemów; i tak dalej

Wspólne sekcje w instrukcjach

Poniżej znajduje się przegląd sekcji, które często znajdziesz w instrukcjach. Nie zakładaj, że każda z nich musi znaleźć się w instrukcji, którą piszesz, ani że musi być w przedstawionej tu kolejności, ani że są to jedyne możliwe sekcje w zestawie instrukcji.

Podczas czytania poniższych informacji o typowych sekcjach w instrukcjach, sprawdź przykładowe instrukcje.

Schematyczny widok instrukcji. Pamiętaj, że jest to typowy lub powszechny model zawartości i organizacji – możliwych jest wiele innych.

Wprowadzenie. Dokładnie zaplanuj wstęp do instrukcji. Upewnij się, że zawiera wszystkie z poniższych rzeczy (ale niekoniecznie w tej kolejności), które odnoszą się do Twojej konkretnej instrukcji:

• Wskazanie konkretnych zadań lub procedur, które mają być wyjaśnione, a także zakresu (czego nie będzie).
• Wskazanie, jakiej wiedzy i kontekstu potrzebuje publiczność, aby zrozumieć instrukcję.
• Przedstawienie ogólnego wyobrażenia o procedurze i jej realizacji.
• Wskazanie warunków, w których instrukcja powinna (lub nie powinna) być stosowana.
• Przedstawienie przeglądu zawartości instrukcji.

Dalsze omówienie znajduje się w rozdziale dotyczącym wstępu.

Ogólne ostrzeżenia, przestrogi, uwagi o niebezpieczeństwie. Instrukcje często muszą ostrzegać czytelników o możliwości zrujnowania sprzętu, spieprzenia procedury i zranienia się. Ponadto, instrukcje muszą często podkreślać kluczowe punkty lub wyjątki. W takich sytuacjach stosuje się specjalne uwagi – uwagi, ostrzeżenia, przestrogi i niebezpieczeństwa. Zwróć uwagę, jak te uwagi specjalne są używane w przykładowych instrukcjach wymienionych powyżej.

Tło techniczne lub teoria. Na początku niektórych rodzajów instrukcji (oczywiście po wprowadzeniu) może być potrzebne omówienie tła związanego z procedurą. W przypadku niektórych instrukcji to tło jest krytyczne – w przeciwnym razie kroki w procedurze nie mają sensu. Na przykład, być może miałeś jakieś doświadczenie z tymi apletami oprogramowania, w których definiujesz własne kolory poprzez przesuwanie suwaków w kolorze czerwonym, zielonym i niebieskim. Aby naprawdę zrozumieć, co robisz, musisz mieć jakieś podstawy na temat kolorów. Podobnie, można sobie wyobrazić, że dla niektórych instrukcji wykorzystujących aparaty fotograficzne, trochę teorii może być również potrzebne.

Sprzęt i materiały. Zauważ, że większość instrukcji zawiera listę rzeczy, które należy zgromadzić przed rozpoczęciem procedury. Obejmuje to sprzęt, narzędzia, których używasz w procedurze (takie jak miski do mieszania, łyżki, patelnie do chleba, młotki, wiertarki i piły) i zaopatrzenie, rzeczy, które są zużywane w procedurze (takie jak drewno, farba, olej, mąka i gwoździe). W instrukcjach są one zazwyczaj wymienione w postaci prostej listy pionowej lub dwukolumnowej. Użyj dwukolumnowej listy, jeśli musisz dodać specyfikacje do niektórych lub wszystkich elementów – na przykład nazwy marek, rozmiary, ilości, typy, numery modeli i tak dalej.

Dyskusja o krokach. Kiedy dojdziesz do rzeczywistego pisania kroków, jest kilka rzeczy, o których należy pamiętać: (1) strukturę i format tych kroków, (2) informacje uzupełniające, które mogą być potrzebne, oraz (3) punkt widzenia i ogólny styl pisania.

Struktura i format. Zazwyczaj wyobrażamy sobie zestaw instrukcji jako sformatowany w postaci pionowych numerowanych list. I większość z nich jest taka w rzeczywistości. Zwykle w ten sposób formatujesz swoje rzeczywiste instrukcje krok po kroku. Istnieją jednak pewne różnice, a także inne względy:

• Kroki o stałej kolejności to kroki, które muszą być wykonane w przedstawionej kolejności. Na przykład, jeśli zmieniasz olej w samochodzie, spuszczenie oleju jest krokiem, który musi nastąpić przed włożeniem nowego oleju. Są to listy numerowane (zwykle pionowe listy numerowane).
• Kroki o zmiennym porządku to kroki, które mogą być wykonywane praktycznie w dowolnej kolejności. Dobrym przykładem są te przewodniki rozwiązywania problemów, które mówią ci, abyś sprawdził to, sprawdź tamto, gdzie próbujesz coś naprawić. Możesz wykonać tego typu kroki w praktycznie dowolnej kolejności. Z tego typu, lista wypunktowana jest odpowiedni format.
• Alternatywne kroki są te, w których dwa lub więcej sposobów, aby osiągnąć to samo, są przedstawione. Alternatywne kroki są również używane, gdy mogą istnieć różne warunki. Używaj list wypunktowanych z tym typem, z OR wstawionym pomiędzy alternatywy, lub lead-in wskazujący, że alternatywy mają być przedstawione.
• Kroki zagnieżdżone. W niektórych przypadkach poszczególne kroki w procedurze mogą być dość złożone same w sobie i muszą być podzielone na podkroki. W takim przypadku wcina się dalej i sekwencjonuje podetapy jako a, b, c, i tak dalej.
• Instrukcje „bezkrokowe”. I wreszcie istnieją instrukcje, które naprawdę nie mogą korzystać z numerowanej listy pionowej i które w niewielkim stopniu, jeśli w ogóle, kierują czytelnikiem w stylu prostej instrukcji. Niektóre sytuacje muszą być tak uogólnione lub tak zmienne, że nie można podać kroków.

Zobacz rozdział o listach dla stylu i formatu tych możliwości.

Dyskusja uzupełniająca. Często nie wystarczy po prostu powiedzieć czytelnikom, aby zrobili to lub tamto. Potrzebują oni dodatkowych informacji wyjaśniających, takich jak jak rzecz powinna wyglądać przed i po kroku; dlaczego powinno im zależeć na wykonaniu tego kroku; jaka mechaniczna zasada stoi za tym, co robią; nawet więcej wyjaśnień na poziomie mikro kroku – omówienie konkretnych działań, które składają się na krok.

Problem z uzupełniającą dyskusją, jednakże, jest taki, że może ona ukryć rzeczywisty krok. Chcesz, aby rzeczywisty krok – konkretne działania, które czytelnik ma podjąć – wyróżniał się. Nie chcesz, aby to wszystko było zakopane w stercie słów. Istnieją co najmniej dwie techniki pozwalające uniknąć tego problemu: można rozdzielić instrukcję od suplementu na osobne akapity lub pogrubić instrukcję.

Pogrubianie rzeczywistych kroków użytkownika w instrukcjach. Pogrubienie tekstu pomaga odróżnić rzeczywistą czynność od informacji uzupełniających.

Styl pisania. Sposób, w jaki faktycznie piszesz instrukcje, zdanie po zdaniu, może wydawać się sprzeczny z tym, czego nauczyły Cię poprzednie zajęcia z pisania. Zauważ jednak, jak pisze się „prawdziwe” instrukcje – używa się w nich wielu imperatywnych (rozkazujących lub bezpośrednio adresowych) rodzajów pisma; używa się w nich wielu „ty”. Jest to całkowicie właściwe. Chcesz stanąć twarzą w twarz z czytelnikiem, przyciągnąć jego pełną uwagę. Z tego powodu zdania w stylu instruktażowym brzmią tak: „Teraz naciśnij przycisk Pauza na panelu przednim, aby tymczasowo zatrzymać wyświetlacz” oraz „Powinieneś uważać, aby nie…”

Szczególny problem wiąże się z użyciem głosu biernego w instrukcjach. Z jakiegoś dziwnego powodu, niektóre instrukcje brzmią tak: „Należy nacisnąć przycisk Pauza, aby tymczasowo zatrzymać wyświetlanie”. Nie tylko martwimy się o zdrowie psychiczne przycisku pauzy, ale zastanawiamy się, kto ma go nacisnąć (mówisz do mnie?). Albo rozważ ten przykład: „Przycisk Timer jest następnie ustawiony na 3:00”. Ponownie, jako osoba wykonująca te instrukcje, możesz tego nie zauważyć; możesz myśleć, że jest to po prostu odniesienie do jakiegoś istniejącego stanu, lub możesz się zastanawiać, „Czy oni mówią do mnie?”. Prawie tak samo złe jest używanie trzeciej osoby: „Użytkownik powinien następnie nacisnąć przycisk Pause”. Ponownie, jest to stary double-take: rozglądasz się po pokoju i zastanawiasz się, „Kto ja?”. (Aby uzyskać więcej szczegółów, zobacz passive-voice problem.)

Innym z typowych problemów ze stylem pisania w instrukcjach jest to, że ludzie wydają się chcieć opuścić artykuły: „Naciśnij przycisk Pause na przednim panelu, aby tymczasowo zatrzymać wyświetlanie informacji” lub „Ziemianinie, proszę podać adres najbliższej pizzerii”. Dlaczego to robimy? Czy wszyscy potajemnie chcemy być robotami? W każdym razie, pamiętaj, aby uwzględnić wszystkie partykuły (a, an, the) i inne tego typu słowa, których normalnie używamy w instrukcjach.

Grafika w instrukcjach

Prawdopodobnie bardziej niż w jakiejkolwiek innej formie pisania (może z wyjątkiem komiksów), grafika jest kluczowa dla instrukcji. Czasami słowa po prostu nie są w stanie wyjaśnić danego kroku. Ilustracje są często krytyczne dla zdolności czytelników do wizualizacji tego, co mają zrobić.

W kursie pisania technicznego, instrukcje mogą wymagać dołączenia ilustracji lub innych rodzajów grafiki – cokolwiek byłoby normalnie używane w instrukcjach. Problemem może być oczywiście to, że nie masz dostępu do grafik, które nadawałyby się do Twoich konkretnych instrukcji, a także to, że nie czujesz się zbyt pewnie ze swoimi zdolnościami artystycznymi. Istnieją sposoby, aby przezwyciężyć te problemy! Zapoznaj się z sugestiami dotyczącymi grafiki. W tym rozdziale zobaczysz nie tylko sugestie dotyczące tworzenia grafiki, ale także wymagania dotyczące jej formatu.

Format w instrukcjach

Nagłówki. W swoich instrukcjach dobrze wykorzystuj nagłówki. Zazwyczaj potrzebujesz nagłówków dla każdej sekcji tła, sekcji sprzętu i materiałów, ogólnego nagłówka dla właściwej sekcji instrukcji i podtytułów dla poszczególnych zadań lub faz w tej sekcji. Przyjrzyj się przykładom na początku tego rozdziału. Zobacz nagłówki dla wspólnych wymagań.

Listy. Podobnie, instrukcje zazwyczaj w dużym stopniu wykorzystują listy, szczególnie numerowane listy pionowe dla rzeczywistych wyjaśnień krok po kroku. Proste listy pionowe lub dwukolumnowe są zazwyczaj dobre dla sekcji sprzętu i materiałów. Listy w zdaniach są dobre, gdy dajesz przegląd rzeczy, które mają nastąpić. Zobacz listy dla wspólnych wymagań.

Uwagi specjalne. W instrukcjach musisz ostrzec czytelników o możliwościach, w których mogą oni uszkodzić sprzęt, zmarnować zapasy, spowodować niepowodzenie całej procedury, zranić siebie lub innych – nawet poważnie lub śmiertelnie. Firmy były pozywane za brak takich specjalnych wskazówek, za źle napisane wskazówki specjalne lub za wskazówki specjalne, które były nie na miejscu. Zobacz uwagi specjalne, aby uzyskać pełne omówienie właściwego stosowania tych uwag specjalnych, jak również ich formatu i umiejscowienia w instrukcjach.

Wyjaśnienie uwag w instrukcjach. W pierwszym przykładzie zwróć uwagę, jak wcięta jest informacja w stosunku do tekstu poprzedzającego krok. W drugim przykładzie zauważ, że ostrzeżenie jest umieszczone na początku, przed jakimkolwiek krokiem.

Liczby, skróty i symbole. Instrukcje również używają wielu liczb, skrótów i symboli. Aby uzyskać wskazówki dotyczące tych obszarów.

Lista kontrolna poprawek instrukcji

Podczas ponownego czytania i poprawiania instrukcji zwróć uwagę na następujące problemy:

• Upewnij się, że podajesz prawdziwe instrukcje – objaśnienia, jak coś zbudować, obsługiwać lub naprawić.
• Napisz dobry wstęp – wskaż w nim dokładną procedurę, która ma być wyjaśniona, określ wymagania odbiorców i zapewnij przegląd treści.
• Upewnij się, że używasz różnych rodzajów list wszędzie tam, gdzie jest to właściwe. W szczególności, używaj numerowanych list pionowych dla kolejnych kroków.
• Używaj nagłówków do wyróżnienia wszystkich głównych sekcji i podtytułów dla podrozdziałów. (Pamiętaj, że nagłówek „Wstęp” nie jest potrzebny między tytułem a pierwszym akapitem. Pamiętaj, aby nie używać nagłówków pierwszego poziomu w tym zadaniu; zacznij od drugiego poziomu.)
• Użyj specjalnych notatek, jeśli to właściwe.
• Upewnij się, że używasz stylu i formatu dla wszystkich nagłówków, list, notatek specjalnych i grafiki, jak przedstawiono w tych rozdziałach. Jeśli stanowi to problem, skontaktuj się ze swoim instruktorem.
• Użyj grafiki, aby zilustrować wszelkie kluczowe działania lub obiekty.
• Zapewnij dodatkowe, uzupełniające objaśnienia kroków, jeśli to konieczne.
• Pamiętaj o stworzeniu sekcji wymieniającej sprzęt i materiały eksploatacyjne, jeśli to konieczne.

Będę wdzięczny za twoje przemyślenia, reakcje, krytykę dotyczącą tego rozdziału: twoja odpowiedź-David McMurrey.

.