Technical Writing for Technicians

Jednym z najbardziej powszechnych i ważnych zastosowań pisma technicznego jest instrukcje – te krok po kroku wyjaśnienia, jak robić rzeczy: zmontować coś, obsługiwać coś, naprawić coś, lub wyjaśnić osobisty proces (zapisywanie się do college’u, na przykład), tak, że czytelnicy mogą lepiej zrozumieć i ewentualnie użyć go samodzielnie.

Teksty procesowe są bardzo powszechne w szkole i zawodów. W szkole nauczyciele często zlecają zadania związane z procesem. Na przykład, profesorowie nauk humanistycznych mogą poprosić o opis ewolucji okresu artystycznego lub literackiego; profesorowie historii – o opis wkładu przywódców danej kultury w czasie; profesorowie nauk społecznych – o chronologię wynalazków; profesorowie inżynierii – o wyjaśnienie, w jaki sposób dźwięk jest zamieniany na sygnały elektryczne; profesorowie biznesu – jak działa Rezerwa Federalna lub jak sprzedać produkt.

Na co dzień czytamy teksty opisujące procesy, w tym przepisy kulinarne, instrukcje obsługi nowego oprogramowania lub felietony z poradami, jak schudnąć lub jak odnieść sukces w szkole lub zawodzie. Teksty te skupiają się na odpowiedzi na jedno z następujących pytań:

  • „Jak to jest zrobione?”
  • „Jak mogę to zrobić?”

Choć tematy raportów procesowych lub zestawów instrukcji mogą się różnić, wiele z nich jest podobnych: większość z nich jest napisana, aby wyjaśnić, jak coś działa, większość jest zorganizowana w porządku chronologicznym z wykorzystaniem numerowanych kroków, a większość opiera się w dużym stopniu na wizualizacjach. W pisaniu instrukcji do nauki nowego programu komputerowego, na przykład, pisarze mogą używać zrzutów ekranu i / lub filmów na ekranie, aby przejść użytkowników przez samouczek.

Ogólnie, dobrze jest mieć zarówno tekst i wizualizacje w instrukcji, ponieważ publiczność prawdopodobnie składa się z ludzi o różnych stylach uczenia się. Jednakże, użycie wizualizacji może się różnić w zależności od odbiorców i przeznaczenia instrukcji. Wizualizacje pomagają wyjaśnić koncepcję, którą trudno jest wyjaśnić za pomocą słów. Grafiki mogą być używane do pokazania, jak coś wygląda, jak coś powinno wyglądać po wykonaniu danego kroku, jak coś jest zrobione lub skonstruowane, pokazują trendy lub zależności, dodają życia do projektu lub po prostu pomagają uporządkować informacje. Grafika jest przydatna, ponieważ prawie wszyscy (w tym dzieci i osoby posługujące się innym językiem) mogą zrozumieć instrukcje wizualne i zobaczyć dokładnie, co muszą wykonać.

Typy instrukcji

Są trzy główne typy tekstów procesowych:

      • Procesy opisowe: odpowiadają one na pytanie: „Jak to się robi?”. Teksty te opisują, jak zachodzi dany proces, aby czytelnicy mogli go lepiej zrozumieć. Na przykład, opisanie procesu rejestracji na kurs online, a nie osobiście, może być przydatne dla kogoś, kto nigdy nie rejestrował się online.
      • Procesy opisowe: mają charakter wyjaśniający; opisują, jak coś jest robione (lub powinno być robione), aby czytelnicy mogli to zrobić sami. Są to najczęściej spotykane rodzaje dokumentów instruktażowych. Na przykład, można napisać przewodnik po procesie normatywnym dla użytkowników, wyjaśniający jak wykonać podstawowe czynności konserwacyjne w samochodzie, takie jak samodzielna wymiana oleju, sprawdzenie świec zapłonowych lub wymiana klocków hamulcowych. *Przykłady wymienione poniżej są przykładami procesów normatywnych.
      • Mieszane procesy opisowe i normatywne sprawiają, że główna część dokumentu jest procesem opisowym, a jednocześnie zawiera kilka sekcji podsumowujących, w jaki sposób czytelnicy mogą wykonać proces. Innymi słowy, autorzy mogą odnieść się zarówno do „Jak mogę to zrobić?” jak i „Jak to jest zrobione?” w różnych częściach jednego tekstu. Alternatywnie, mogą oni opracować różne wersje tego samego dokumentu dla dwóch grup odbiorców – grupy użytkowników i grupy zainteresowanych stron.

Zaczynamy

Rysunek 4.1

Na początku projektu lub zadania związanego z pisaniem instrukcji ważne jest, aby rozważyć grupę odbiorców i określić charakterystykę (liczbę zadań i kroków) konkretnej procedury, o której zamierzasz pisać.

Grupa odbiorców i sytuacja: Na wczesnym etapie procesu zdefiniuj publiczność i sytuację swoich instrukcji. Pamiętaj, że zdefiniowanie publiczności oznacza określenie jej poziomu wiedzy i znajomości tematu. Czasami pomocne jest opisanie odbiorców najpierw samemu sobie, a następnie wykorzystanie tego do oceny wiadomości na końcu, aby upewnić się, że jest ona odpowiednia dla odbiorców.

Liczba zadań: Ważnym rozważaniem jest to, ile zadań jest w procedurze, dla której piszesz instrukcje. Termin procedura może odnosić się do całego zestawu czynności, które omawia Twoja instrukcja, natomiast termin zadanie może być użyty do określenia częściowo niezależnej grupy czynności w ramach procedury. Na przykład ustawienie modemu jest jednym zadaniem w ogólnej procedurze podłączania komputera do Internetu.

Jako inny przykład, prosta procedura, taka jak wymiana oleju w samochodzie, zawiera tylko jedno zadanie; nie ma w niej półzależnych grup innych czynności. Bardziej złożona procedura, jak korzystanie z kuchenki mikrofalowej, zawiera mnóstwo częściowo niezależnych zadań, takich jak ustawianie zegara, ustawianie poziomu mocy, używanie timera, czyszczenie i konserwacja mikrofalówki, i więcej.

Niektóre instrukcje mają tylko jedno zadanie, ale mają wiele kroków w ramach tego pojedynczego zadania. Na przykład, wyobraź sobie zestaw instrukcji do montażu zestawu huśtawek dla dzieci. Jednym z efektywnych podejść byłoby pogrupowanie podobnych i powiązanych kroków w fazy, a następnie zmiana numeracji kroków w każdej nowej fazie. Faza to grupa podobnych kroków w ramach procedury pojedynczego zadania. W przykładzie zestawu huśtawkowego, ustawienie ramy byłoby jedną fazą; zakotwiczenie rzeczy w ziemi byłoby inną; a montaż huśtawki pudełkowej byłby jeszcze inną.

Skoncentrowanie instrukcji

Innym rozważaniem, którego być może nie możesz określić na początku, jest to, jak skupić swoje instrukcje. Dla większości instrukcji, możesz skupić się na zadaniach, lub możesz skupić się na potrzebnych narzędziach.

      • W podejściu zadaniowym do instrukcji na temat używania automatycznej sekretarki, będziesz miał sekcje na temat nagrywania powitania, odtwarzania wiadomości, zapisywania wiadomości, przekazywania wiadomości i usuwania wiadomości. Są to zadania – typowe rzeczy, które użytkownicy chcieliby robić z maszyną.
      • Z drugiej strony, w podejściu narzędziowym do instrukcji na temat używania kserokopiarki, byłyby sekcje na temat przycisku kopiowania, przycisku anulowania, przycisku powiększania/pomniejszania, przycisku składania/zszywania, podajnika papieru, przycisku rozmiaru kopii, i tak dalej. Jeśli zaprojektowałbyś zestaw instrukcji na tym planie, prawdopodobnie napisałbyś kroki do użycia każdego przycisku lub funkcji kserokopiarki.

Instrukcje Zawartość

Pamiętaj, aby przeczytać sekcję „Projektowanie dokumentu” przed stworzeniem instrukcji. Uwzględnij następujące elementy:

Wprowadzenie: Starannie planując wprowadzenie do instrukcji, pamiętaj, aby:

        • Wskazać konkretne zadania lub procedurę, które należy wyjaśnić.
        • Wskazać, czego potrzebują słuchacze pod względem wiedzy i tła, aby zrozumieć instrukcję.
        • Podać ogólne wyobrażenie o procedurze i jej realizacji.
        • Podać warunki, w których instrukcja powinna (lub nie powinna) być stosowana.
        • Przedstawić przegląd treści instrukcji.

Ogólne ostrzeżenia, przestrogi, uwagi o niebezpieczeństwie: Instrukcje muszą również ostrzegać czytelników o możliwości zepsucia sprzętu, spieprzenia procedury i/lub zrobienia sobie krzywdy. Ponadto, instrukcje muszą podkreślać kluczowe punkty lub wyjątki. W takich sytuacjach należy używać specjalnych uwag, takich jak Uwaga, Ostrzeżenie, Przestroga i/lub Niebezpieczeństwo.

Techniczne tło lub teoria: Na początku niektórych instrukcji (zwykle 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. W niektórych przypadkach autorzy instrukcji mogą być zmuszeni do spędzenia znacznej ilości czasu na wyjaśnianiu rzeczy czytelnikom, zanim przejdą do faktycznych kroków związanych z procesem.

Sprzęt i materiały: Większość instrukcji zawiera listę rzeczy, które należy zgromadzić przed rozpoczęciem procedury. Obejmuje to sprzęt, narzędzia używane w procedurze (takie jak miski do mieszania, łyżki, patelnie do chleba, młotki, wiertarki i piły) i materiały, 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 prostej pionowej liście lub w dwukolumnowej liście na początku instrukcji. 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 na temat kroków: Kiedy dojdziesz do rzeczywistego pisania kroków, upewnij się, że dokładnie rozważasz strukturę i format tych kroków, wszelkie dodatkowe informacje, które mogą być potrzebne, a także punkt widzenia i ogólny styl pisania instrukcji. Jednym z punktów widzenia wykorzystywanych w pisaniu tekstów technicznych jest druga osoba, która zwraca się do odbiorców jak do siebie.

* Ogólnie rzecz biorąc, autorzy instrukcji powinni dążyć do następujących celów:

      • Używaj jasnego, prostego pisania, kiedy tylko jest to możliwe.
      • Dokładne zrozumienie procesu we wszystkich jego technicznych szczegółach.
      • Pracuj nad postawieniem się na miejscu czytelnika, który będzie korzystał z Twoich instrukcji.
Rysunek 4.2

Próbki instrukcji dla uczniów

  • Próbka instrukcji spawania (próbka dla ucznia)
  • Próbka instrukcji mechatroniki – badanie diod. & Tranzystory (przykład dla studentów)
  • Auto/Diesel Instrukcje – Jak wymienić tylny wahacz w Toyocie Corolli (przykład dla studentów)
  • Łóżko Jak zmienić struny gitarowe (próbka dla ucznia)

Profesjonalne instrukcje

  • Spawanie Instrukcja Przykład 1 (próbka profesjonalna)
  • Barbie Dreamhouse (próbka profesjonalna)
  • Montaż trampoliny (próbka profesjonalna)

.

Dodaj komentarz

Twój adres e-mail nie zostanie opublikowany.