Jednym z najbardziej powszechnych i ważnych zastosowań pisma technicznego jest dostarczenie instrukcji, te krok po kroku wyjaśnienia, jak złożyć, obsługiwać, naprawić lub zrobić rutynową konserwację na coś. Chociaż mogą wydawać się intuicyjne i proste do napisania, instrukcje są jednymi z najgorzej napisanych dokumentów, jakie można znaleźć. Większość z nas miała zapewne wiele wściekłych doświadczeń ze źle napisanymi instrukcjami. Ten rozdział pokaże Ci, co profesjonaliści uważają za najlepsze techniki w dostarczaniu instrukcji.
Skuteczny zestaw instrukcji wymaga następujących elementów:
- Jasnego, precyzyjnego i prostego pisania
- Dokładnego zrozumienia procedury we wszystkich jej technicznych szczegółach
- Umiejętności postawienia się na miejscu czytelnika, osoby próbującej skorzystać z twojej instrukcji
- Umiejętności szczegółowego zwizualizowania procedury i uchwycenia tej świadomości na papierze
- Chęci przetestowania instrukcji na osobie, dla której je napisałeś.
Na początku projektu pisania zestawu instrukcji ważne jest, aby określić strukturę lub charakterystykę konkretnej procedury, o której zamierzasz pisać. Oto kilka kroków, które należy wykonać:
Wykonaj staranną analizę publiczności i zadań
Wcześniej w procesie, zdefiniuj publiczność i sytuację swojej instrukcji. Pamiętaj, że zdefiniowanie publiczności oznacza określenie poziomu znajomości tematu przez Twoich czytelników.
Określ liczbę zadań
Ile zadań jest w procedurze, o której piszesz? Używajmy terminu procedura w odniesieniu do całego zestawu czynności, które Twoja instrukcja ma omawiać. Zadanie to półniezależna grupa czynności w ramach procedury: na przykład ustawienie zegara w kuchence mikrofalowej jest jednym zadaniem w dużej ogólnej procedurze obsługi kuchenki mikrofalowej.
Prosta procedura, taka jak wymiana oleju w samochodzie, zawiera tylko jedno zadanie; nie ma w niej półniezależnych grup czynności. Bardziej złożona procedura, taka jak używanie kuchenki mikrofalowej, zawiera kilka częściowo niezależnych zadań: ustawianie zegara; ustawianie poziomu mocy; używanie timera; czyszczenie i konserwacja mikrofalówki, między innymi.
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 zestawem huśtawkowym, ustawienie ramy będzie fazą; zakotwiczenie rzeczy w ziemi będzie kolejną; montaż huśtawki skrzyniowej będzie jeszcze inną.
3. Określ najlepsze podejście do dyskusji krok po kroku
W przypadku 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ł następujące sekcje:
- Nagrywanie powitania
- Odtwarzanie wiadomości
- Zapisywanie wiadomości
- Przekazywanie wiadomości
- Usuwanie wiadomości, i tak dalej
To są zadania – typowe rzeczy, które chcielibyśmy zrobić z automatem.
Z drugiej strony, w podejściu narzędziowym do instrukcji na temat używania kserokopiarki, prawdopodobnie byłyby sekcje na temat tego, jak używać konkretnych funkcji:
- Przycisk kopiowania
- Przycisk anulowania
- Przycisk powiększania/pomniejszania
- Przycisk zszywania
- Przycisk kopiowania rozmiaru, i tak dalej
Jeżeli zaprojektowałbyś zestaw instrukcji na tym planie, napisałbyś kroki dla użycia każdego przycisku lub funkcji kserokopiarki. Instrukcje używające ten narzędzia podejście są trudne robić pracy. 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, mogą zdarzyć się sytuacje, w których podejście narzędzia/właściwości może być lepsze.
4. Projektowanie grup zadań
Listowanie zadań może nie być wszystkim, co musisz zrobić. Może być tak wiele zadań, że musisz je pogrupować, aby czytelnicy mogli łatwiej znaleźć poszczególne z nich. Na przykład następujące grupy zadań są często spotykane w instrukcjach:
- Zadania rozpakowania i konfiguracji
- Zadania instalacji i dostosowywania
- Podstawowe zadania operacyjne
- Rutynowe zadania konserwacyjne
- Zadania rozwiązywania problemów.
Wspólne sekcje w instrukcjach
Poniżej znajduje się przegląd sekcji, które często można znaleźć 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.
W celu zapoznania się z alternatywnymi formatami, sprawdź przykładowe instrukcje.
Wprowadzenie: starannie zaplanuj wprowadzenie do instrukcji. Może on zawierać dowolne z poniższych elementów (ale niekoniecznie w tej kolejności):
- Wskazanie konkretnych zadań lub procedury do wyjaśnienia, a także zakresu (co będzie, a co nie będzie objęte instrukcją)
- Wskazanie, czego słuchacze potrzebują w zakresie wiedzy i tła, aby zrozumieć instrukcję
- Ogólne wyobrażenie o procedurze i o tym, co osiąga
- Wskazanie warunków, w których ta instrukcja powinna (lub nie powinna) być używana
- Przedstawienie przeglądu zawartości instrukcji.
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 zrobienia sobie krzywdy. Ponadto, instrukcje muszą często podkreślać kluczowe punkty lub wyjątki. W takich sytuacjach stosuje się uwagi specjalne – 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 (po wprowadzeniu) może być potrzebne omówienie tła związanego z procedurą. Dla 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 przy użyciu kamer, trochę teorii może być potrzebne, jak również.
Sprzęt i materiały: zauważ, że większość instrukcji zawiera listę rzeczy, które trzeba zebrać 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 faktycznego 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: zwykle wyobrażamy sobie zestaw instrukcji jako sformatowany w postaci pionowych numerowanych list. I większość z nich jest 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 ustalonym porządku to kroki, które muszą być wykonane w przedstawionej kolejności. Na przykład, jeśli zmieniasz olej w samochodzie, spuszczanie oleju jest krokiem, który musi przyjść przed umieszczeniem nowego oleju. Są to listy numerowane (zwykle pionowe listy numerowane).
- Kroki o zmiennym porządku to kroki, które mogą być wykonywane w praktycznie dowolnej kolejności. Dobrym przykładem są te przewodniki rozwiązywania problemów, które mówią ci, żebyś sprawdził to, sprawdził tamto, gdzie próbujesz coś naprawić. Możesz wykonać tego typu kroki w praktycznie dowolnej kolejności. Z tego typu, wypunktowana lista jest odpowiedni format.
- Alternatywne kroki są te, w których dwa lub więcej sposobów na osiągnięcie tego samego 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 będą wkrótce przedstawione.
- Zagnieżdżone kroki mogą być używane w przypadkach, gdy poszczególne kroki w procedurze są dość złożone same w sobie i muszą być rozbite na pod-kroki. W tym przypadku, wcina się dalej i sekwencjonuje pod-kroki jako a, b, c, i tak dalej.
- Instrukcje „bez-krokowe”. mogą być używane, gdy naprawdę nie można użyć numerowanej listy pionowej lub zapewnić prostego instruktażowego stylu kierowania czytelnikiem. Niektóre sytuacje muszą być tak uogólnione lub tak zmienne, że nie można podać kroków.
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 zasada mechaniczna 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żesz rozdzielić instrukcję od suplementu na osobne akapity; lub możesz pogrubić instrukcję.
Styl pisania
Pogrubienie kluczowych kroków użytkownika może być bardzo pomocnym sposobem wyraźnego zasygnalizowania czytelnikowi, co ma zrobić. Często czasownik polecenia jest pogrubiony; czasami pogrubiona czcionka podkreśla kluczowy element, który jest omawiany.
Używanie głosu biernego w instrukcjach może być problematyczne. Z jakiegoś dziwnego powodu niektóre instrukcje brzmią tak: „Należy nacisnąć przycisk Pauza, aby tymczasowo zatrzymać wyświetlacz”. Nie tylko obawiamy się o zdrowie psychiczne przycisku pauzy, ale zastanawiamy się, kto ma go nacisnąć (ninja?). Bardziej pomocne byłoby wskazanie, kiedy czytelnik musi „nacisnąć przycisk pauzy”. Rozważmy taki przykład: „Przycisk Timer jest wtedy ustawiony na 3:00”. I znów można by zapytać: „jest ustawiany przez kogo? Ninjas?” Osoba podążająca za tymi instrukcjami może myśleć, że jest to po prostu odniesienie do jakiegoś istniejącego stanu, albo może się zastanawiać: „Czy oni mówią do mnie?”. Używanie trzeciej osoby również może prowadzić do niezręczności: „Użytkownik powinien następnie nacisnąć przycisk Pause”. Instrukcje powinny być zazwyczaj pisane z użyciem form czasownika rozkazującego i z użyciem „ty”, aby było całkowicie jasne, co czytelnik powinien zrobić.
Ilustrowanie instrukcji
Prawdopodobnie bardziej niż w jakiejkolwiek innej formie pisma technicznego, 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ć. Upewnij się, że grafika przedstawia obraz z perspektywy czytelnika.
Formatowanie instrukcji
Ponieważ ludzie rzadko chcą czytać instrukcje, ale często muszą, sformatuj instrukcje dla niechętnej czytelności. Postaraj się, aby Twój czytelnik chciał je przeczytać, a przynajmniej nie miał oporów przed zapoznaniem się z nimi. Format o wysokiej czytelności pozwoli czytelnikom, którzy samodzielnie rozgryźli część instrukcji, przeskoczyć do sekcji, w której utknęli. Użyj tego, czego nauczyłeś się o nagłówkach, listach, wizualizacjach i pasywnej przestrzeni, aby stworzyć efektywne i czytelne instrukcje:
Nagłówki: normalnie, chciałbyś mieć nagłówki dla każdej sekcji tła, którą możesz mieć, sekcji sprzętu i materiałów, ogólny nagłówek dla rzeczywistej sekcji instrukcji i podtytuły dla poszczególnych zadań lub faz w tej sekcji.
Listy: podobnie, instrukcje zazwyczaj szeroko 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 do zrobienia.
Uwagi specjalne: może być konieczne, aby ostrzec czytelników o możliwościach, w których mogą 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 ostrzeżeń, za źle napisane specjalne ostrzeżenia lub za specjalne ostrzeżenia, 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.
Przy ponownym czytaniu i poprawianiu instrukcji sprawdź, czy spełniają one następujące warunki:
- Jasno opisują dokładną procedurę, która ma być wyjaśniona
- Zapewniają przegląd treści
- Wskazują wymagania publiczności
- Tam, gdzie jest to właściwe, stosuj różne rodzaje list; w szczególności, używaj numerowanych list dla kolejnych kroków
- Używaj nagłówków i podtytułów aby podzielić główne sekcje i podrozdziały w logicznym, spójnym porządku
- Używaj specjalnych uwag w razie potrzeby
- Używaj grafiki aby zilustrować kluczowe działania i przedmioty
- Dostarczaj dodatkowych wyjaśnień dotyczących kroków w razie potrzeby
- Stwórz sekcję zawierającą listę sprzętu i materiałów, jeśli to konieczne.
.