Techniczne pisanie - Technical writing

Pisanie techniczne to pisanie lub szkicowanie komunikacji technicznej stosowanej w dziedzinach technicznych i zawodowych, takich jak sprzęt i oprogramowanie komputerowe , inżynieria , chemia , aeronautyka , robotyka , finanse , medycyna , elektronika użytkowa , biotechnologia i leśnictwo . Pisanie techniczne obejmuje największą poddziedzinę w komunikacji technicznej.

Towarzystwo Komunikacji Technicznej definiuje komunikację techniczną jako jakąkolwiek formę komunikacji, która charakteryzuje się jedną lub więcej z następujących cech: „(1) komunikujące o tematach technicznych i specjalistycznych, takich jak programy komputerowe, procedur medycznych, lub przepisów dotyczących ochrony środowiska, (2) komunikuje za pomocą technologii, takiej jak strony internetowe, pliki pomocy lub serwisy społecznościowe; lub (3) dostarczanie instrukcji dotyczących sposobu wykonania danej czynności, niezależnie od stopnia technicznego wykonania zadania”.

Przegląd

Pisanie techniczne jest wykonywane przez pisarza technicznego (lub autora technicznego) i jest procesem pisania i udostępniania informacji technicznych w profesjonalnym otoczeniu. Podstawowym zadaniem autora tekstów technicznych jest przekazywanie informacji technicznych innej osobie lub stronie w możliwie jak najjaśniejszy i najskuteczniejszy sposób. Informacje, które przekazują pisarze techniczni, są często złożone, dlatego niezbędne są silne umiejętności pisania i komunikacji. Pisarze techniczni nie tylko przekazują informacje za pomocą tekstu, ale muszą również biegle posługiwać się komputerami. Autorzy techniczni korzystają z szerokiej gamy programów do tworzenia i edycji ilustracji , programów do tworzenia diagramów do tworzenia pomocy wizualnych oraz procesorów dokumentów do projektowania, tworzenia i formatowania dokumentów.

Chociaż pisanie techniczne jest powszechnie kojarzone z pomocą online i podręcznikami użytkownika , termin dokumentacja techniczna może obejmować szerszy zakres gatunków i technologii. Komunikaty prasowe , notatki , raporty , oferty biznesowe , arkusze danych , opisy i specyfikacje produktów , białe księgi , życiorysy i podania o pracę to tylko kilka przykładów pism , które można uznać za dokumentację techniczną . Niektóre rodzaje dokumentacji technicznej zazwyczaj nie są obsługiwane przez autorów technicznych. Na przykład komunikat prasowy jest zwykle pisany przez autora public relations, chociaż pisarz techniczny może mieć wkład w jakiekolwiek informacje techniczne zawarte w komunikacie prasowym.

Historia

Chociaż pisarstwo techniczne zostało uznane za zawód dopiero od czasów II wojny światowej , jego korzenie sięgają klasycznej starożytności . Krytycy przytaczają dzieła pisarzy takich jak Arystoteles jako najwcześniejsze formy pisma technicznego. Praca Geoffreya Chaucera , Traktat o astrolabium, jest wczesnym przykładem dokumentu technicznego . Najwcześniejsze przykłady pisma technicznego sięgają okresu staroangielskiego.

Wraz z wynalezieniem mechanicznej prasy drukarskiej , nadejściem Renesansu i nastaniem Wieku Rozumu , dokumentowanie odkryć stało się koniecznością. Wynalazcy i naukowcy, tacy jak Isaac Newton i Leonardo da Vinci, przygotowali dokumenty, które przedstawiały ich wynalazki i odkrycia. Chociaż nigdy nie były nazywane dokumentami technicznymi w okresie ich publikacji, dokumenty te odegrały kluczową rolę w rozwoju nowoczesnych form komunikacji technicznej i pisma.

Pole komunikacji technicznej rozrosło się w czasie rewolucji przemysłowej . Narastała potrzeba dostarczania ludziom instrukcji obsługi coraz bardziej skomplikowanych maszyn, które były wymyślane. Jednak w przeciwieństwie do przeszłości, w której umiejętności były przekazywane poprzez tradycje ustne, nikt poza wynalazcami nie wiedział, jak korzystać z tych nowych urządzeń. W ten sposób pisanie stało się najszybszym i najskuteczniejszym sposobem rozpowszechniania informacji, a poszukiwani byli pisarze, którzy mogliby udokumentować te urządzenia.

W XX wieku zapotrzebowanie na pisanie techniczne gwałtownie wzrosło, a zawód został oficjalnie uznany. Wydarzenia I i II wojny światowej doprowadziły do ​​postępu w medycynie, sprzęcie wojskowym, technologii komputerowej i technologiach lotniczych. Ten szybki rozwój, w połączeniu z pilną potrzebą wojny, stworzył natychmiastową potrzebę dobrze zaprojektowanej dokumentacji wspierającej korzystanie z tych technologii. Pisanie techniczne było w tym czasie bardzo poszukiwane, a „pisarz techniczny” stał się oficjalnym tytułem zawodowym podczas II wojny światowej .

Po II wojnie światowej postęp technologiczny doprowadził do wzrostu dóbr konsumpcyjnych i standardu życia. Podczas powojennego boomu usługi publiczne, takie jak biblioteki i uniwersytety, a także systemy transportowe, takie jak autobusy i autostrady, odnotowały znaczny wzrost. Wzrosła potrzeba kronikowania tych procesów przez pisarzy. Również w tym okresie duże firmy i uczelnie zaczęły korzystać z komputerów. Warto zauważyć, że w 1949 roku Joseph D. Chapline jest autorem pierwszego obliczeniowego dokumentu technicznego, instrukcji obsługi komputera BINAC .

Wynalezienie tranzystora w 1947 r. umożliwiło produkcję komputerów taniej i w zakresie zakupów dla osób prywatnych i małych firm. Wraz ze wzrostem rynku tych „ komputerów osobistych ” rosła potrzeba tworzenia autorów, którzy mogliby wyjaśnić i dostarczyć dokumentację dla użytkowników tych urządzeń. W latach 70. i 80. zawód pisarstwa technicznego rozwijał się dalej, gdy elektronika użytkowa trafiała do domów coraz większej liczby osób.

W ostatnich latach znaczenie komputerów w społeczeństwie doprowadziło do wielu postępów w dziedzinie komunikacji cyfrowej, prowadząc do zmian w narzędziach używanych przez pisarzy technicznych. Hipertekst , edytory tekstu , programy do edycji grafiki i oprogramowanie do układania stron sprawiły, że tworzenie dokumentów technicznych jest szybsze i łatwiejsze, a współcześni pisarze techniczni muszą być biegli w tych programach.

Techniki

Dobre pisanie techniczne jest zwięzłe, skoncentrowane, łatwe do zrozumienia, wolne od błędów i oparte na odbiorcach. Pisarze techniczni skupiają się na tym, aby ich dokumenty były jak najbardziej przejrzyste, unikając nadmiernie technicznych fraz i wyborów stylistycznych, takich jak głos bierny i nominalizacje. Ponieważ dokumenty techniczne są używane w rzeczywistych sytuacjach, zawsze powinno być wyraźnie jasne, jaki jest przedmiot dokumentu technicznego i jak wykorzystać przedstawione informacje. Byłoby katastrofalne, gdyby na przykład instrukcje pisarza technicznego dotyczące korzystania z aparatu rentgenowskiego o dużej mocy były trudne do rozszyfrowania.

Pisanie techniczne wymaga od pisarza dogłębnego zbadania swoich odbiorców. Pisarz techniczny musi być świadomy istniejącej wiedzy odbiorców na temat omawianego materiału, ponieważ baza wiedzy odbiorców pisarza określa treść i przedmiot dokumentu. Na przykład raport ewaluacyjny omawiający wyniki badań naukowych, napisany dla grupy wysoko wykwalifikowanych naukowców, będzie skonstruowany zupełnie inaczej niż raport przeznaczony dla ogółu społeczeństwa. Pisarze techniczni nie muszą sami być ekspertami merytorycznymi (MŚP). Często współpracują z MŚP przy realizacji zadań, które wymagają większej wiedzy na dany temat niż oni sami.

Pismo techniczne musi być dokładne. Pisarz techniczny, po przeanalizowaniu swoich odbiorców, wie, co musi przekazać, a następnie musi przekazać wiadomość w sposób dokładny i etyczny. Jeśli pisarz zrobi to niepoprawnie, mogą wystąpić reperkusje fizyczne, środowiskowe lub finansowe. Znajomość odbiorców jest niezbędna do dokładności, ponieważ język zostanie dostosowany do tego, co już rozumieją na dany temat. Na przykład instrukcje dotyczące prawidłowego i bezpiecznego montażu półki na książki są dołączone do zakupu. Instrukcje te są skonstruowane tak, aby każdy mógł je śledzić, w tym dokładne szczegóły dotyczące tego, gdzie znajduje się każdy element złączny. Gdyby te instrukcje były niedokładne, regał mógłby być niestabilny i ulec awarii.

Projekt i układ dokumentów są również istotnymi elementami pisania technicznego. Pisarze techniczni spędzają dużo czasu na upewnianiu się, że ich dokumenty są czytelne, ponieważ źle zaprojektowany dokument utrudnia czytanie zrozumienia. Projekt dokumentu technicznego kładzie nacisk na właściwe wykorzystanie opcji projektu dokumentu, takich jak wypunktowanie, rozmiar czcionki i pogrubiony tekst. Obrazy, diagramy i filmy są również powszechnie wykorzystywane przez pisarzy technicznych, ponieważ te media często mogą przekazywać złożone informacje, takie jak roczne dochody firmy lub cechy projektu produktu, znacznie wydajniej niż tekst.

Dokumentacja techniczna

Pismo techniczne obejmuje wiele gatunków i stylów pisania, w zależności od informacji i odbiorców. Dokumenty techniczne nie są tworzone wyłącznie przez autorów technicznych. Prawie każdy, kto pracuje w profesjonalnym otoczeniu, produkuje różne dokumenty techniczne. Niektóre przykłady dokumentacji technicznej obejmują:

  • Instrukcje i procedury to dokumenty, które pomagają programistom lub użytkownikom końcowym obsługiwać lub konfigurować urządzenie lub program. Przykłady dokumentów instruktażowych obejmują podręczniki użytkownika i przewodniki rozwiązywania problemów dotyczące programów komputerowych, sprzętu komputerowego, produktów gospodarstwa domowego, sprzętu medycznego, produktów mechanicznych i samochodów.
  • Propozycje . Większość projektów zaczyna się od propozycji — dokumentu, który opisuje cel projektu, zadania, które będą wykonywane w projekcie, metody użyte do ukończenia projektu i wreszcie koszt projektu. Propozycje obejmują szeroki zakres tematów. Na przykład pisarz techniczny może napisać propozycję, która określa, ile będzie kosztować instalacja nowego systemu komputerowego, specjalista ds. marketingu może napisać propozycję z ofertą produktów, a nauczyciel może napisać propozycję, która opisuje, w jaki sposób nowa klasa biologii zostaną ustrukturyzowane.
  • E-maile , listy i memoranda to jedne z najczęściej pisanych dokumentów w firmie. Listy i e-maile można konstruować z różnymi celami — niektóre mają zwykle na celu po prostu przekazywanie informacji, podczas gdy inne mają na celu przekonanie odbiorcy do wykonania określonego zadania. Podczas gdy listy są zwykle pisane do osób spoza firmy, memoranda (notatki) są dokumentami pisanymi do innych pracowników w firmie.
  • Komunikaty prasowe . Gdy firma chce publicznie ujawnić nowy produkt lub usługę, otrzyma od autora komunikat prasowy . Jest to dokument opisujący funkcje i wartość produktu dla społeczeństwa.
  • Specyfikacje to zarysy projektu, które opisują strukturę, części, opakowanie i dostawę obiektu lub procesu na tyle szczegółowo, aby inna strona mogła go zrekonstruować. Na przykład pisarz techniczny może stworzyć diagram i napisać specyfikacje smartfona lub roweru, aby producent mógł wyprodukować przedmiot.
  • Opisy to krótsze wyjaśnienia procedur i procesów, które pomagają czytelnikom zrozumieć, jak coś działa. Na przykład pisarz techniczny może napisać dokument, który pokazuje wpływ gazów cieplarnianych lub demonstruje, jak działa układ hamulcowy roweru.
  • Życiorysy i podania o pracę to kolejny przykład dokumentów technicznych. Są to dokumenty używane w profesjonalnym otoczeniu do informowania czytelników o referencjach autora.
  • Raporty techniczne są pisane w celu dostarczenia czytelnikom informacji, instrukcji i analizy zadań. Raporty przychodzą w wielu formach. Na przykład, pisarz techniczny może ocenić budynek, który jest na sprzedaż i sporządzić raport z podróży, który podkreśla jego lub jej odkrycia i czy uważa, że ​​budynek powinien zostać zakupiony. Inny pisarz, który pracuje dla firmy non-profit, może opublikować raport ewaluacyjny, który pokazuje wyniki badań firmy nad zanieczyszczeniem powietrza.
  • Studium przypadku to opublikowany raport na temat osoby, grupy lub sytuacji, która była badana na przestrzeni czasu; także  : sytuacja w prawdziwym życiu, którą można obejrzeć lub zbadać, aby się czegoś dowiedzieć. Na przykład trudna sytuacja danej osoby w jej miejscu pracy i sposób jej rozwiązania to studium przypadku.
  • Białe księgi to dokumenty napisane dla ekspertów w danej dziedzinie i zazwyczaj opisujące rozwiązanie wyzwania lub problemu technologicznego lub biznesowego. Przykłady białych ksiąg obejmują artykuł, który szczegółowo opisuje, jak wyróżnić firmę na rynku lub artykuł wyjaśniający, jak zapobiegać cyberatakom na firmy.
  • Strony internetowe . Pojawienie się hipertekstu zmieniło sposób czytania, organizowania i uzyskiwania dostępu do dokumentów. Współcześni pisarze techniczni są często odpowiedzialni za tworzenie stron na stronach internetowych, takich jak strony „O nas” lub strony produktów. Często oczekuje się od nich, że będą biegli w narzędziach do tworzenia stron internetowych.
  • Arkusze danych to dokumenty podsumowujące funkcje, kluczowe specyfikacje, charakterystyki techniczne, obwody aplikacji i kilka innych ważnych informacji o produkcie, maszynie, sprzęcie, oprogramowaniu, aplikacji lub systemie w skrócie.
  • Przewodniki API są napisane dla społeczności programistów i służą do wyjaśnienia interfejsów programowania aplikacji .
  • Systemy pomocy to centra pomocy online, które dostarczają użytkownikom informacji technicznych o produktach i usługach. Dostarczają treści jako strony internetowe, które są wyświetlane w przeglądarce. Treść może być utworzona w oprogramowaniu centrum pomocy, takim jak Zendesk , lub w narzędziach do tworzenia pomocy lub komponentowych systemach zarządzania treścią, które mogą tworzyć centrum pomocy jako wynik HTML.

Narzędzia

Następujące narzędzia są używane przez pisarzy technicznych do tworzenia i prezentowania dokumentów:

  • Narzędzia DTP lub edytory tekstu . Pisarze techniczni używają procesorów tekstu, takich jak Scrivener, Microsoft Word , Apple Pages i LibreOffice Writer, do tworzenia, edytowania, projektowania i drukowania dokumentów. Ponieważ pisanie techniczne dotyczy w równym stopniu układu strony, co języka pisanego,używane są równieżulepszone narzędzia DTP, takie jak Adobe InDesign i LyX . Programy te działają podobnie do edytorów tekstu, ale zapewniają użytkownikom więcej opcji i funkcji projektowania dokumentu oraz automatyzują większość formatowania.
  • Pomoc narzędzia autorskie . Są one używane przez autorów technicznych do tworzenia systemów pomocy, które są dostarczane z oprogramowaniem, dostarczane przez przeglądarki internetowe lub dostarczane jako pliki, które użytkownicy mogą przeglądać na swoich komputerach. Pisząc procedury instruktażowe opisujące programy mechaniczne, elektryczne lub programowe, autorzy techniczni używają tych narzędzi, aby pomóc im w uproszczeniu procesów montażu, obsługi lub instalacji.
  • Komponentowe systemy zarządzania treścią . Są one również wykorzystywane przez pisarzy technicznych do tworzenia systemów pomocy i dokumentów. Systemy CCMS (Component Content Management Systems) umożliwiają autorom tworzenie podobnych danych wyjściowych jako pomocnych narzędzi do tworzenia, ale zapewniają również funkcje zarządzania treścią, takie jak zarządzanie wersjami i wbudowane przepływy pracy.
  • Oprogramowanie do edycji obrazu . Często obrazy i inne elementy wizualne mogą przekazywać informacje lepiej niż akapity tekstu. W takich przypadkach oprogramowanie do edycji obrazu, takie jak Adobe Photoshop i GIMP, jest używane przez pisarzy technicznych do tworzenia i edytowania wizualnych aspektów dokumentów, takich jak zdjęcia, ikony i diagramy.
  • Oprogramowanie do współpracy. Ponieważ pisanie techniczne często wiąże się z komunikacją między wieloma osobami pracującymi dla różnych firm, może to być sprawa współpracy. Autorzy techniczni używają systemów Wiki i wspólnych obszarów roboczych dokumentów do pracy z innymi autorami i stronami w celu konstruowania dokumentów technicznych.
  • Narzędzia do tworzenia stron internetowych . Zadania pisarza technicznego nie ograniczają się już tylko do tworzenia dokumentów. Czasami tworzą także treści dla firmowych i innych profesjonalnych witryn internetowych. Dlatego można oczekiwać, że pisarze techniczni będą biegli w narzędziach do tworzenia stron internetowych, takich jak Adobe Dreamweaver .
  • Edytory tekstu . Programy takie jak Microsoft Notepad , TextEdit lub Wordstar pozwalają pisarzom technicznym na edycję zwykłego tekstu . Edytory tekstu mogą być używane do zmiany zawartości, takiej jak pliki konfiguracyjne, pliki dokumentacji i kod źródłowy języka programowania . Edytory tekstu są szeroko stosowane przez pisarzy technicznych pracujących z treściami online.
  • Oprogramowanie graficzne. Aby przekazywać informacje statystyczne, takie jak liczba wizyt w restauracji lub kwota pieniędzy, jaką uczelnia wydaje na programy sportowe, pisarze techniczni wykorzystują wykresy i schematy blokowe. Podczas gdy programy takie jak Microsoft Excel i Word mogą tworzyć podstawowe wykresy i wykresy, czasami pisarze techniczni muszą tworzyć bardziej złożone i szczegółowe wykresy, które wymagają funkcji niedostępnych w tych programach i mogą wymagać skorzystania z narzędzi do tworzenia wykresów i diagramów (np. Microsoft Visio ).
  • Narzędzia do przechwytywania ekranu. Pisarze techniczni często używają narzędzi do przechwytywania ekranu, takich jak Camtasia i Snagit . Tworząc instrukcje dla oprogramowania komputerowego, pisarzowi technicznemu może być łatwiej po prostu nagrać krótki film z ich pulpitów podczas wykonywania zadania, niż byłoby to napisanie długiej serii instrukcji opisujących, jak należy wykonać zadanie. Narzędzia do przechwytywania ekranu służą również do wykonywania zrzutów ekranu programów i oprogramowania działającego na komputerach użytkowników, a następnie do tworzenia towarzyszących im diagramów.

Lista stowarzyszeń

Bibliografia

Linki zewnętrzne