Lista źródeł dla początkujących technical writerów
Dla osób, które ciekawi kim jest technical writer i dla tych, które chcą zrobić pierwsze kroki w tym kierunku, przedstawiamy zestaw linków do materiałów.
Oto "pakiet startowy" dla zainteresowanych dużą zmianą w życiu zawodowym. Być może jeszcze nie wiesz, czy technical writing to Twoja bajka. Po przejrzeniu tych materiałów, będzie Ci łatwiej podjąć decyzję. Jeśli materiały wydadzą Ci się intrygujące, gratulujemy i zapraszamy do dalszego zgłębiania tematu. To co tu pokazujemy, to wierzchołek góry lodowej, ale w którymś miejscu trzeba zacząć.
Poniższe zestawienie jest szczególnie przydatne podczas tworzenia dokumentacji do oprogramowania po angielsku.
Podstawowe informacje o technical writingu
Wiele osób stawia sobie na początku pytania: "Jak to jest być technical writerem?" i "Na czym to polega?". Po przeczytaniu tych materiałów powinno się to stać bardziej jasne.
Komunikacja techniczna - co to jest, kto się tym zajmuje i dlaczego?
Kim jest Subject Matter Expert (SME) i jak z nim rozmawiać?
Dobra dokumentacja - cechy i etapy tworzenia
Noty wydania (Release Notes) - co, jak, dla kogo?
Co piszą tech writerzy? Zestawienie popularnych treści technicznych
Prezentacja Andrzeja z podstawowymi informacjami
Strona konferencji Write The Docs z definicjami podstawowych pojęć
Film YouTube definiujacy technical writing i pokrewne specjalności
Jeśli chodzi o definicje istotnych kategorii i zagadnień to dla osób początkujących to polecam Technical Writer HQ, bo regularnie dostarcza porcje przydatnych informacji:
Baza wiedzy na stronie Technical Writer HQ: Technical documentation
Technical Writer HQ: Proces tworzenia dokumentacji
Zarobki
Jednym z istotnych pytań jest to, ile się w tym zawodzie zarabia. Ankieta płac pomoże Ci to oszacować.
Zdobywanie doświadczenia: projekty Open Source
Dobrym sposobem na zbudowanie portfolio jest zaangażować się w projekt Open Source.
Projekty open source technical writerów
Jak dostać pierwszą pracę
Poniżej znajdziesz wiele wskazówek na bazie rzeczywistych doświadczeń.
Spojrzenie całościowe
Jak zostać technical writerem?
Techwriter szuka pierwszej pracy
Jak opracować dobre CV
CV - najważniejszy dokument Tech Writera
Testy rekrutacyjne
Tłumacz odkrywa tech writing
Jeśli jesteś anglistką bądź anglistą, to mam dla Ciebie dobrą wiadomość: wiele umiejętności, które już posiadasz, pomoże Ci w nowej roli. Poniżej relacje dwóch osób, które taką drogę odbyły.
Gdzie szukać pomocy
Tech Writer w opałach. Gdzie szukać pomocy?
Kluczowe pojęcia
DITA
DITA jest standardem, dzięki któremu treść jest rozbita na małe bloki o określonym celu, np.: koncepcja, referencja, zadanie. Pozwala on na używanie tej samej treści w wielu miejscach.
CCMS
Ważna koncepcja powiązana z DITA. Jej definicję znajdziecie w tej sekcji:
Wszystko o DITA - Narzędzia - CCMS
Docs as Code
"Docs as Code" lub "Docs like Code" to metoda i filozofia traktowania dokumentacji w podobny sposób jak kod. Przy użyciu narzędzi i praktyk programistycznych, możemy usprawnić współpracę technical writera i zespołu deweloperskiego.
Zapraszamy do zapoznania się z tymi odcinkami podcastu Techwriter Koduje. Warto tam zrobić pierwsze kroki. Przy każdym odcinku znajdziecie linki do dalszych źródeł.
#1 Docs like code - rozważania praktyczne i filozoficzne
#41 Tech Writer rozważa podobieństwa i różnice między kodowaniem a pisaniem dokumentacji
#65 Tech Writer broni docs as code, czyli klasyczne "u mnie działa"
#72 Tech Writer pyta innych o docs as code, czyli kto i dlaczego porzuca CCMSy
#81 Tech Writer VS Coduje, czyli pisanie dokumentacji w modelu docs as code
Kolejne dwa wspaniałe źródła:
Artykuł firmy 3di o Markdown, formacie stosowanym w Docs as Code
Cykl przystępnych artykułów Łukasza Michty o Doc as Code
Dokumentacja API
Ważnym tematem dla dokumentacji oprogramowania jest tworzenie dokumentacji dla programistów integrujących różne komponenty w swoich rozwiązaniach.
Tom Johnson stworzył kompendium wiedzy na ten temat. Jest to też rozbudowany materiał szkoleniowy:
I'd Rather Be Writing: Documenting APIs
Standardy
Podręczniki stylów
Spójność jest w cenie. Podręczniki stylów definiują to jak zwracamy się do czytelnika, zalecane słowa i wyrażenia, ton wypowiedzi, formatowanie, interpunkcja i wiele innych.
Oprócz samego podręcznika stylu Google, znajdziesz też materiały dla osób początkujących. Jest możliwość wzięcia udziału w darmowej sesji szkoleniowej online:
Kurs Google Developers Guidelines
Prosty język
Simplified Technical English (STE) wywodzi się z branży lotniczej. Jeśli chcesz poznać, jak używać bardziej zrozumiałych słów i wyrażeń w języku angielskim, zapoznaj się z tym standardem. Jest on szczególnie przydatny podczas pisania instrukcji.
STE - jak używać go w praktyce
Strona, na której możecie poznać ten standard lepiej, dowiedzieć się o akredytowanych trenerach i szkoleniach, zamówić bezpłatnie dostęp do PDF do słownika i zasad gramatycznych:
ASD Simplified Technical English Maintenance Group
Diataxis
Krótkie opracowanie, które pomoże Ci dzielić typy tworzonych treści wedle funkcji edukacyjnej jaką ona pełni. Szybko się czyta i dużo układa w głowie. Oprócz tego podziału, znajdziesz też kryteria dla udanej dokumentacji.
ITCQF
Mimo, że fundacja która stworzyła ten standard zakończyła swoją działalność, to sam sylabus ITCQF nie traci na aktualności. To opracowanie nakreślające ramy technical writingu, kluczowe definicje i dobre praktyki.
Dodatkowe źródła wiedzy
Podcast
Warto wsłuchać się w to, co dwaj redaktorzy mają do powiedzenia, bo pięknie przybliżają techniczną stronę technical writingu i zapraszają ciekawych gości.
Blog
Bardzo popularny blog o technical writingu, zawiera same konkrety pisane przez bardzo doświadczonego profesjonalistę.
Meetupy
Jeśli interesujesz się technical writingiem i masz możliwość wzięcia udziału w meetupie to koniecznie to zrób! Poznasz użyteczną wiedzę i szalenie pomocnych ludzi.
Konferencje
Konferencje to świetne okazje do nauki i networkingu.
Kurs na Akademii Vistula
Kurs podyplomowy o komunikacji technicznej na Akademii Vistula to unikatowa propozycja i szansa na poznanie szerokiej gamy narzędzi, którymi technical writer zarabia na chleb 😊.
Seria artykułów o studiach na Akademii Vistula
Zakończenie
Powyżej zamieściliśmy garść linków. Znasz coś równie pomocnego, co powinno trafić na tę listę? Daj nam znać!
Osobom, którym zależy na wiedzy i znalezieniu nowej pracy, życzymy udanych poszukiwań.
Grafikę tytułową wygenerowaliśmy w Copilot.