pisanie TECHNICZNE to praktyka przetwarzania dokumentów i wizualizacji, informacji słownych i demonstracji do materiałów szkoleniowych. Celem pisania technicznego jest dostarczenie materiału, który wyjaśnia proces lub ułatwia zrozumienie złożonej koncepcji dla określonej grupy odbiorców. Dzięki wydajnemu i skutecznemu pisaniu technicznym pisarz będzie w stanie wyjaśnić i pomóc czytelnikowi w zrozumieniu informacji i wykonaniu określonych zadań. Istnieje pięć uniwersalnych zasad etycznych pisania technicznego. Zasady to jakość treści, odbiorcy i cel, dostępność, gramatyka i styl pisania.
jakość treści
jakość treści jest subiektywna. Definicja wysokiej jakości treści MATC to produkt, który spełnia standardy klienta lub wykracza poza początkowy zakres projektu. Aby stworzyć projekt wysokiej jakości, musisz pisać z myślą o zamierzonej publiczności. Autor musi zbadać dodatkową wiedzę potrzebną przed ukończeniem dokumentu lub materiału. Autor musi wiedzieć, jaki format lub platforma będzie używana do reprezentowania informacji. Autor musi określić konkretne informacje, które wahają się od wiedząc, jakie są terminy, aby wiedzieć, dlaczego informacje muszą być napisane.
publiczność i cel
pisarz musi zrozumieć zarówno cel, jak i publiczność, aby stworzyć wybitny utwór techniczny. Publiczność pisania technicznego różni się w zależności od branży i konkretnego klienta. Na przykład publiczność raportu okrążenia byłaby producentem produktu, który zatrudnił nas jako pisarzy. Odbiorcą modułu szkoleniowego e-learningowego może być bank lub dostawca kredytów hipotecznych, który potrzebuje szkolenia w zakresie zgodności. Pisarz musi wiedzieć, ile czytelnicy będą wiedzieć i jakie obowiązki pisarz jest zobowiązany do wypełnienia, jeśli chodzi o komunikację z czytelnikami.
dostępność
ważne jest, aby publiczność mogła łatwo uzyskać dostęp do informacji, które pisarz stworzył. Dostępność obejmuje wszystko, co znajduje się w dokumencie, takie jak nagłówki i stopki lub Moduły iLearn komputera, które poprawiają formatowanie dostępności, aby było bardziej uniwersalne i przejrzyste. Autor techniczny musi znaleźć najlepszą metodę, aby pomóc czytelnikom poruszać się po dokumentacji z notacjami od bibliografii do numerów stron do spisu treści. Autor mógł nawet dodać wizualizacje, takie jak wykresy i liczby, aby wyjaśnić dalsze informacje.
Gramatyka
Pisanie jasne, zwięzłe i proste przy odpowiednim użyciu gramatyki jest niezbędne w pisaniu każdego artykułu technicznego. Autor musi również skorygować i edytować wszelkie techniczne prace pisane w celu skorygowania błędów lub niespójności z gramatyką, stylem i układem. Pisarz techniczny powinien zawsze pisać w czasie teraźniejszym, chyba że Klient wskaże swoje preferencje. Czytelnik artykułu technicznego powinien robić dokładnie to, co podajesz instrukcje. Pisarz powinien zawsze pisać w prostych zdaniach, które zawierają rzeczowniki neutralne płciowo. Proste zdania pomagają czytelnikom jasno i skutecznie zrozumieć zadania, które muszą podjąć, aby osiągnąć swoje cele.
styl pisania
styl pisania różni się dla każdego utworu technicznego, ponieważ w dużej mierze zależy od tego, kto jest odbiorcą i scenariusza, dla którego utwór techniczny jest pisany. Ton technicznego utworu pisarskiego jest niezbędny, ponieważ pomaga czytelnikowi zrozumieć, jaki rodzaj tonu jest wymagany do wykonania zadania. Wybór słów jest również istotną częścią stylu, pomagając zaspokoić potrzeby odbiorców, ponieważ łączy się z tym, kim są Twoi odbiorcy. Podczas odwoływania się do sekcji informacji lub stron internetowych konieczne jest zapewnienie jasnych i widocznych sposobów dostępu do informacji za pomocą narzędzi, takich jak rysunki i tabele.
inne wskazówki dotyczące pisania technicznego
wykonaj dodatkowe badania i dowiedz się więcej
wiedząc, że minimum może nie uzyskać najlepszego elementu technicznego, aby pomóc publiczności zrozumieć informacje. Może być wiele terminologii, których zarówno pisarz, jak i czytelnik mogą nie zrozumieć. Z reguły, jeśli jako czytelnik nie rozumiesz pojęcia lub terminu, zdefiniuj go. Zbyt wiele informacji zawsze można wyciąć w późniejszych recenzjach. Informacje te powinny być zbadane, aby zrozumieć, jak to działa z tym, co pisarz pisze jako całość. Zbadaj małego ojca i dowiedz się, jakie inne informacje można wykorzystać do ulepszenia pisanego utworu technicznego.
Zostań widownią i nie doceniaj widowni
postaw się na miejscu widowni. Czy możesz wyraźnie zrozumieć i postępować zgodnie z instrukcjami lub informacjami, które napisałeś dla publiczności? Jeśli tak, możesz podać więcej informacji, jeśli uważasz, że potrzebuje trochę więcej pomocy. Jeśli nie, musisz znaleźć części, które nie są jasne i znaleźć sposób na prawidłowe dostarczenie informacji. Dużym problemem, który często mają pisarze techniczni, jest to, że przeceniają wiedzę swoich odbiorców. Widownią może być wiele osób na różnych poziomach wiedzy. Jest całkowicie dopuszczalne, aby krótko podać informacje, które można założyć lub już podane jako przypomnienie dla publiczności.
poproś o drugą i trzecią opinię i recenzję
pisarze techniczni są zaradni. Największym zasobem, jaki posiadasz, są eksperci od przedmiotów. Pamiętaj, aby zapytać swoje MŚP, czy widzą jakieś luki w wiedzy lub błędy. Pisarze sprawdzają u swoich klientów, czy nie ma żadnych luk w wiedzy lub błędów, które pisarz może przeoczyć. Posiadanie przełożonego lub kolegi, który przejrzy i wyda opinię, może również pomóc w ulepszeniu elementu technicznego. Recenzja jest wtedy, gdy grupa ludzi spotyka się, aby czytać, komentować i polecać ulepszenia swojej pracy. Więcej martwych punktów ujawnia się, gdy więcej osób przejrzy dokument, co zapewnia dokładne i zwięzłe informacje.
pisarze techniczni uczą się nowych informacji o każdym projekcie, nad którym pracują. Autorzy lepiej rozumieją, czego potrzebują klienci, ponieważ zaczynają poniżej poziomu wiedzy swoich czytelników przed wszystkimi badaniami i dyskusjami z ekspertami tematycznymi. Staje się to wielkim atutem dla firm, ponieważ mniejsze założenia otwierają się na bardziej efektywne szkolenia. Połączenie pisarzy uczących się materiału i tych zasad etycznych technicznych standardów pisania prowadzą do bardziej pewnych siebie i wydajnych pracowników.