Technical Writing Essentials

Opisowe pismo techniczne wykorzystuje kombinację obrazów i tekstu, aby zarówno „pokazać”, jak i „opowiedzieć” czytelnikowi o przekazywanej informacji. Podobnie jak bardziej kreatywne opisy, opisy techniczne czasami czerpią z „pięciu zmysłów” i metaforycznych porównań (analogii), aby umożliwić czytelnikowi pełną konceptualizację tego, co jest opisywane. Częściej jednak opierają się na konkretnych, wymiernych deskryptorach. Opisy techniczne mogą przybierać różne formy, w zależności od celu i odbiorców. Opisy mogą obejmować od krótkiego zdania, przez akapit, całą sekcję raportu lub cały podręcznik. Źle napisane opisy techniczne mogą powodować zamieszanie, marnować czas, a nawet prowadzić do katastrofy! Techniczne opisy produktów są często wymagane prawnie, aby zapewnić bezpieczeństwo i zgodność z przepisami. Dbałość o szczegóły jest krytyczna.

Specyfikacje produktów wymagają szczegółowych opisów cech konstrukcyjnych; instrukcje często wymagają konkretnych szczegółów opisowych, aby „pokazać” czytelnikowi, co ma robić. Niektóre ogólne kategorie opisów technicznych obejmują następujące elementy:

• Opisy mechanizmów: zapewniają szczegółowy przegląd fizycznych aspektów narzędzia, maszyny lub innego urządzenia mechanicznego, które ma ruchome części i jest przeznaczone do wykonywania określonej funkcji. Mogą to być opisy produktów do sprzedaży lub produkcji, dokumentacja specyfikacji projektowych, info-grafiki, itp. Ten rozdział skupia się szczegółowo na tym rodzaju opisu.
• Opisy procesów: szczegółowo opisują serię zdarzeń (zjawisko naturalne/biologiczne/ekologiczne, mechaniczne, społeczne lub psychologiczne), które zachodzą w określonej kolejności w celu osiągnięcia określonego wyniku. Można je podzielić na procesy nieinstruktażowe (takie jak analiza procesu działania silnika spalinowego lub procesów naturalnych, takich jak fotosynteza) i procesy instruktażowe (takie jak zalecane/wymagane procedury i wyraźne instrukcje krok po kroku, których należy przestrzegać). (Zobacz Sekcja 7.7 dla szczegółowych informacji na temat Writing Instructions).
• Definicje: wyjaśnić konkretne znaczenie, często związane z określonym kontekście, lub wyrazić istotną naturę terminów, które są definiowane. Mogą one mieć różną długość, od prostego zdania wyjaśniającego do rozbudowanego dokumentu liczącego kilka stron. Definicje często zawierają szczegółowe opisy i wizualizacje ilustrujące idee. Kliknij na poniższy link, aby obejrzeć prezentację PowerPoint dla studentów na temat pisania skutecznych definicji dla celów technicznych. Ta prezentacja jest zamieszczona za wyraźną zgodą studenta.

Definitions in Technical Writing – Sample student presentation (.pdf)

Opisy mechanizmów powinny zapewniać jasne zrozumienie opisywanego obiektu, w tym

• Ogólny wygląd i właściwości fizyczne
• Ogólna funkcja/przeznaczenie
• Części składowe
• Jak części oddziałują na siebie tworząc funkcjonującą całość.

Czytelnik powinien być w stanie jasno wyobrazić, a zatem zrozumieć, charakter obiektu opisywanego, co robi, i jak to działa.

W celu osiągnięcia tej jasności dla czytelnika, pisarz musi wybrać znaczące szczegóły i zorganizować informacje logicznie. Wybierz szczegóły, które mogą być opisane dokładnie i wymiernie, takie jak

W zależności od potrzeb czytelnika, opis może wahać się od ogólnego przeglądu wymagającego tylko kilku zdań do wielorozdziałowego podręcznika szczegółowo opisującego każdy aspekt części i funkcji mechanizmu w celu rozwiązywania problemów technicznych i kompletnych napraw. Zabawnym przykładem tego ostatniego jest Star Trek: The Next Generation: Technical Manual (okładka przedstawiona na rysunku 7.4.1), który zawiera szczegółowe opisy całego sprzętu i technologii używanych na pokładzie fikcyjnego U.S.S. Enterprise-D.

Zanim zaczniesz tworzyć swój opis, musisz rozważyć swój cel i odbiorców: Dlaczego Twoi odbiorcy potrzebują tego opisu? Do czego będą go używać? Czy opisujesz różne typy paneli słonecznych dla przeciętnych konsumentów, aby pomóc im wybrać ten, który najlepiej pasuje do ich potrzeb? Czy dajesz schematy dla techników i instalatorów?

Gdy już masz swój cel i odbiorców jasno w centrum uwagi, przygotuj opis, który zawiera następujące elementy:

1. Definicja: Co to jest i jaki jest jego główny cel?
2. Przegląd: Opisać ogólny wygląd mechanizmu („duży obraz”).
3. Komponenty: Opisać główne części składowe w oznaczonych sekcjach; uważnie rozważyć kolejność informacji w tym miejscu. Stwórz logiczny związek pomiędzy każdym opisanym komponentem.
4. Objaśnienie: jak części współpracują ze sobą, aby spełnić swoją funkcję? Jakie kluczowe zasady rządzą jego funkcjonowaniem? Zastanów się, jak wiele szczegółów jest tu potrzebnych dla zamierzonej publiczności.
5. Materiały wizualne: dołącz grafiki, które jasno ilustrują mechanizm i/lub jego części. Pokaż urządzenie jako całość; rozważ pokazanie konkretnych szczegółów w rozszerzonych widokach, wycięciach, lub oznaczonych diagramach. Możesz nawet osadzić lub połączyć się z filmami pokazującymi urządzenie w akcji.
6. Podsumowanie: w zależności od celu, możesz przejrzeć historię produktu, dostępność, produkcję, koszty, ostrzeżenia, itp: Źródła, które wykorzystałeś w swoim opisie, lub dodatkowe dostępne źródła informacji (jeśli są istotne).

Możesz rozważyć użycie szablonu, takiego jak poniższy Szablon opisu technicznego, pamiętając, że chociaż szablony mogą być pomocnymi przewodnikami, nie zapewniają dużej elastyczności i mogą nie sprawdzać się we wszystkich sytuacjach.

Przykładowe opisy

Przeanalizuj opis „Up Goer Five” na Rysunku 7.4.2 (kliknij na obrazek aby powiększyć). Kim może być zamierzona publiczność?

Porównaj opis na Rysunku 7.4.2 z informacjami podanymi na stronie internetowej NASA na temat łazika Mars Curiosity.

Zauważ różnice w poziomie szczegółowości, słownictwie i ogólnym celu opisów. Jeśli użyłeś informacji ze strony NASA do wypełnienia Szablonu Opisu Technicznego, mógłbyś skończyć z czymś takim jak poniższy wykres. Objectives

Może się okazać, że niektóre z tych elementów nie są konieczne; ponownie, zastanów się, co Twoi docelowi odbiorcy już wiedzą. Zachowaj równowagę między niepotrzebnym stwierdzaniem rzeczy oczywistych a błędnym zakładaniem, że czytelnicy posiadają wiedzę, której im brakuje.

Doskonaląc szczegóły opisu i jego części składowych, rozważ następujące kwestie:

• Organizacja: Użyj logicznej zasady, aby uporządkować swój opis
  • Góra do dołu (lub fundament do góry)
  • Lewa do prawej (lub prawa do lewej)
  • Wewnątrz do zewnątrz (lub zewnętrzna do wewnętrznej)
  • Najważniejsze do najmniej ważnych cech
  • Komponent centralny do peryferyjnych
  • Właściwości materiałowe, itp.
• Język: Używaj specyficznych, precyzyjnych, konkretnych terminów – unikaj niejasnych lub zbyt ogólnych terminów
  • Używaj poprawnej terminologii – definiuj terminy tak, jak jest to konieczne dla Twoich odbiorców
  • Używaj analogii, aby opisać nieznaną rzecz w kategoriach znanej rzeczy
  • Używaj obiektywnego języka – żadnego „ad speak” lub subiektywnych terminów
  • Używaj czasu teraźniejszego, czasowników czynnych, aby opisać, jak urządzenie wygląda i co robi
  • Używaj słów, które tworzą żywe i konkretne obrazy w umyśle czytelnika.

Wybierz zwykły, codzienny przedmiot (taki jak jeden z przedmiotów na rysunku 7.4.3) i przygotuj opis techniczny dla publiczności nie znającej tego przedmiotu. Zacznij od wyobrażenia sobie docelowej grupy odbiorców i celu, a następnie spróbuj wypełnić Szablon opisu technicznego szczegółowymi informacjami. Korzystając z informacji zawartych w szablonie, zredaguj krótki opis składający się z 1-2 akapitów i dodaj odpowiednio skrótowe wizualizacje.