Technical writing

Dlaczego: To branżowy standard definiujący ton, strukturę i gramatykę w dokumentacji IT.

Jak:

• Skup się na sekcjach dotyczących 'Tone and Voice' oraz 'Punctuation'.
• Zanotuj zasady używania list punktowanych i wielkich liter.
• Przeanalizuj przykłady 'Do' i 'Don't'.

Gotowe, gdy: Przeczytano kluczowe rozdziały i sporządzono jednostronicową ściągawkę z zasadami.

Dlaczego: Większość nowoczesnej dokumentacji (Docs-as-Code) powstaje w formacie Markdown.

Jak:

• Naucz się formatowania nagłówków, linków, tabel i bloków kodu.
• Przetestuj składnię w edytorze online (np. Dillinger).
• Stwórz plik README.md dla fikcyjnego projektu.

Gotowe, gdy: Samodzielne stworzenie dokumentu zawierającego wszystkie elementy formatowania bez zaglądania do dokumentacji.

Dlaczego: Upraszczanie języka jest kluczowe dla odbiorców międzynarodowych i tłumaczeń maszynowych.

Jak:

• Zapoznaj się z normą ASD-STE100 (podstawowe założenia).
• Ćwicz zamianę strony biernej na czynną.
• Ogranicz używanie wieloznacznych czasowników (np. zamiast 'get' użyj 'obtain' lub 'receive').

Gotowe, gdy: Przeredagowanie 5 skomplikowanych zdań technicznych na formę prostą i bezpośrednią.

Dlaczego: VS Code to najpopularniejsze środowisko do edycji dokumentacji technicznej.

Jak:

• Pobierz i zainstaluj VS Code.
• Dodaj rozszerzenia: 'Markdown All in One', 'Vale' (do sprawdzania stylu) oraz 'Code Spell Checker'.
• Skonfiguruj podgląd Markdown (Ctrl+Shift+V).

Gotowe, gdy: Środowisko jest gotowe do pracy i poprawnie renderuje pliki .md.

Dlaczego: Kontrola wersji jest niezbędna w pracy zespołowej nad dokumentacją.

Jak:

• Zainstaluj Git lokalnie.
• Stwórz repozytorium o nazwie 'Technical-Writing-Portfolio'.
• Przećwicz komendy: git add, git commit, git push.

Gotowe, gdy: Pierwszy plik Markdown został poprawnie wypchnięty do zdalnego repozytorium.

Dlaczego: Dokumentowanie API to jedna z najlepiej płatnych nisz w technical writingu.

Jak:

• Przeczytaj specyfikację OpenAPI 3.0 (podstawy).
• Przeanalizuj demo Swagger Petstore.
• Zrozum strukturę endpointów, parametrów i odpowiedzi (JSON).

Gotowe, gdy: Potrafisz wyjaśnić różnicę między metodą GET a POST oraz opisać strukturę pliku YAML.

Dlaczego: Realne próbki tekstu są ważniejsze dla rekrutera niż certyfikaty.

Jak:

• Wybierz proste narzędzie CLI lub bibliotekę na GitHub.
• Opisz proces instalacji, konfiguracji i pierwszego użycia.
• Zastosuj strukturę: Cel, Wymagania, Kroki, Wynik.

Gotowe, gdy: Dokument o długości 1-2 stron zapisany w formacie Markdown w Twoim repozytorium.

Dlaczego: Technical writer musi umieć tłumaczyć zawiłe procesy, a nie tylko pisać instrukcje 'kliknij tutaj'.

Jak:

• Wybierz temat (np. 'Jak działa uwierzytelnianie OAuth2').
• Stwórz diagram przepływu (użyj narzędzia typu Mermaid.js lub draw.io).
• Opisz proces językiem zrozumiałym dla początkującego programisty.

Gotowe, gdy: Artykuł techniczny z co najmniej jednym schematem graficznym.

Dlaczego: Profesjonalna prezentacja online buduje wiarygodność.

Jak:

• Użyj generatora stron statycznych (np. Hugo lub Jekyll) lub prostego szablonu HTML.
• Podepnij swoje pliki Markdown pod stronę.
• Skonfiguruj GitHub Pages w ustawieniach repozytorium.

Gotowe, gdy: Działający link URL prowadzący do Twojego publicznego portfolio.

Dlaczego: Rekruterzy szukają kandydatów po konkretnych słowach kluczowych.

Jak:

• Dodaj do nagłówka: 'Aspiring Technical Writer | Docs-as-Code | API Documentation'.
• W sekcji 'Featured' dodaj link do swojego portfolio na GitHub Pages.
• Opisz swoje projekty, używając terminologii technicznej (Markdown, Git, DITA).

Gotowe, gdy: Profil zawiera co najmniej 5 słów kluczowych związanych z zawodem i link do portfolio.

Dlaczego: To największa na świecie społeczność technical writerów, oferująca wsparcie i oferty pracy.

Jak:

• Zarejestruj się na Slacku 'Write the Docs'.
• Przedstaw się na kanale #introductions.
• Przejrzyj kanał #career-advice i #jobs.

Gotowe, gdy: Aktywne konto na Slacku i przeczytanie 10 ostatnich wątków dotyczących juniorów.

Dlaczego: Bezpośredni kontakt z praktykami pozwala poznać realia firm i ukryty rynek pracy.

Jak:

• Znajdź na LinkedIn 3 osoby pracujące jako Technical Writer (najlepiej w Twoim mieście/kraju).
• Wyślij spersonalizowaną wiadomość z prośbą o 15 minut rozmowy o ich ścieżce kariery.
• Przygotuj 3 konkretne pytania (np. 'Jakich narzędzi używacie na co dzień?').

Gotowe, gdy: Wysłanie 10 zaproszeń i odbycie co najmniej jednej rozmowy (ustalony termin w kalendarzu).

Dlaczego: Praktyka w procesie rekrutacyjnym jest niezbędna do zdobycia pracy.

Jak:

• Znajdź oferty pracy (LinkedIn, Indeed, No Fluff Jobs).
• Dostosuj CV do każdej oferty, podkreślając znajomość narzędzi (Git, Markdown).
• Dołącz link do portfolio w liście motywacyjnym.

Gotowe, gdy: Potwierdzenie wysłania 5 aplikacji.