Pisanie instrukcji: definicja i przykłady

W pisanie artykułów biznesowych, techniczne pisaniei inne formy kompozycja, instrukcje są pisemnymi lub mówionymi wskazówkami dotyczącymi przeprowadzenia procedury lub wykonania zadania. Jest również nazywany pouczające pisanie.

Instrukcje krok po kroku zazwyczaj używają punkt widzenia drugiej osoby (ty, twój, twój). Instrukcje są zwykle przekazywane w aktywny głos i imperatywny nastrój: skieruj swój publiczność bezpośrednio.

Instrukcje są często pisane w formie numerowanej lista aby użytkownicy mogli wyraźnie rozpoznać sekwencję zadań.

Skuteczne instrukcje zwykle obejmują elementy wizualne (takie jak zdjęcia, diagramy i schematy blokowe), które ilustrują i wyjaśniają tekst. Instrukcje przeznaczone dla odbiorców międzynarodowych mogą polegać całkowicie na zdjęciach i znajomych symbolika. (Są to tak zwane instrukcje bez słów.)

Obserwacje i przykłady

„Dobre instrukcje są jednoznaczne, zrozumiałe, kompletne, spójne i skuteczne”. (John M. Penrose i in., Komunikacja biznesowa dla menedżerów: podejście zaawansowane, 5th ed. Thomson, 2004)

instagram viewer

Jaśniejsza strona instrukcji: Podręcznik dla niedawno zmarłych

Juno: Dobra, czy uczyłeś się instrukcji?
Adam: Próbowaliśmy.
Juno: Rozdział pośredni dotyczący nawiedzeń mówi wszystko. Wyrzućcie je sami. To twój dom. Nawiedzone domy nie są łatwe do zdobycia.
Barbara: Cóż, nie do końca to rozumiemy.
Juno: Słyszałem. Zaraz zajmij twarze. Oczywiście nie ma sensu odrywać głowy od ludzi, jeśli cię nie widzą.
Adam: Czy powinniśmy zacząć od tego prościej?
Juno: Zacznij po prostu, rób to, co wiesz, wykorzystuj swoje talenty, ćwicz. Powinieneś uczyć się tych lekcji od pierwszego dnia. (Sylvia Sidney, Alec Baldwin i Geena Davis w Sok z żuka, 1988)

Podstawowe funkcje

„Instrukcje mają tendencję do przestrzegania spójnego schematu krok po kroku, niezależnie od tego, czy opisujesz, jak zrobić kawę, czy jak zmontować silnik samochodowy. Oto podstawowe cechy instrukcji:

  • Konkretne i precyzyjne tytuł
  • Wprowadzenie z podstawowymi informacjami
  • Lista wymaganych części, narzędzi i warunków
  • Kolejne kroki
  • Grafika
  • Informacje dotyczące bezpieczeństwa
  • Wniosek sygnalizuje zakończenie zadania

Kolejne kroki są centralnym elementem zestawu instrukcji i zwykle zajmują dużo miejsca w dokumencie. ”
(Richard Johnson-Sheehan, Komunikacja techniczna dzisiaj. Pearson, 2005)

Lista kontrolna dotycząca instrukcji pisania

  1. Używaj krótkich zdań i krótkich akapitów.
  2. Ułóż punkty w logicznej kolejności.
  3. Złóż swoje oświadczenia konkretny.
  4. Użyj tryb rozkazujący.
  5. Na początku umieść najważniejszy element w każdym zdaniu.
  6. Powiedz jedno w każdym zdaniu.
  7. Wybierz słowa ostrożnie, unikając żargon i warunki techniczne, jeśli możesz.
  8. Dać przykład lub analogia, jeśli uważasz, że wypowiedź może zaskoczyć czytelnika.
  9. Sprawdź ukończoną wersję roboczą pod kątem logiki prezentacji.
  10. Nie pomijaj kroków ani nie używaj skrótów.

(Przyjęty z Pisanie z precyzją autor: Jefferson D. Bates Pingwin, 2000)

Pomocne wskazówki

„Instrukcje mogą być dokumentami wolnostojącymi lub częścią innego dokumentu. W obu przypadkach najczęstszym błędem jest zbyt skomplikowane dla odbiorców. Ostrożnie rozważ poziom techniczny swoich czytelników. Posługiwać się Biała przestrzeń, grafikę i inne elementy projektu, aby instrukcje były atrakcyjne. Co najważniejsze, pamiętaj o dołączeniu odniesień do Ostrzeżenie, Ostrzeżenie i Niebezpieczeństwo przed kroki, do których się odnoszą ”.
(William Sanborn Pfeiffer, Kieszonkowy przewodnik po komunikacji technicznej, 4th ed. Pearson, 2007)

Instrukcje testowania

Aby ocenić dokładność i przejrzystość zestawu instrukcji, poproś jedną lub więcej osób, aby postępowały zgodnie z Twoimi wskazówkami. Obserwuj ich postępy, aby ustalić, czy wszystkie kroki zostały poprawnie wykonane w rozsądnym czasie. Po zakończeniu procedury poproś tę grupę testową, aby zgłosiła wszelkie napotkane problemy i przedstawiła zalecenia dotyczące ulepszenia instrukcji.