Tech Writer Koduje

Kiedyś było lepiej... A może tak nam się tylko wydaje. Na pewno było inaczej. Powszechny dostęp do dużych modeli językowych sporo namieszał. Teraz możemy użyć takiego czy innego czata właściwie do wszystkiego - rozpisania planu treningowego, zaplanowania wycieczki, stworzenia aplikacji i napisania dokumentacji. Jednak sam fakt, że możemy czegoś użyć nie oznacza od razu, że powinniśmy. Pewne rzeczy...

We thought that after so many years in tech comm we knew a lot about this field. Then, we met Sharon Burton who proved us wrong. She is a seasoned Tech Writer and the author of the "Women in Technical Communication" book. It contains 69 stories of female experts, which show us the intricate history of technical communication. Sharon joined us in this episode to talk about the evolution o...

Ciężko jest wbić gwoździa kapciem. Lepiej użyć do tego młotka. W komunikacji technicznej, tak jak w życiu codziennym, odpowiednie narzędzie ułatwia nam osiągnięcie celu. Jednak wybór tego odpowiedniego to niełatwe zadanie. Oferta jest bardzo bogata, producenci obiecują złote góry, a liczba wymagań jest zazwyczaj długa. Rozmawiamy o tym jak wygląda kompletny proces wdrażania narzędzia w organizacji...

AI jest wszędzie - w pracy, w szkole, w domu, a nawet w lodówce. Dlatego poczuliśmy się w obowiązku, żeby przyjrzeć się roli technoskryby w tym ciekawym momencie rozwoju technologicznego, w którym obecnie się znajdujemy. Tempo rozwoju jest tak szybkie, że ten odcinek prawdopodobnie szybko przestanie być aktualny, jednak mamy nadzieję, że chociaż część naszych wniosków i przemyśleń pozostanie ponad...

Trudno nie zgodzić się z tym, że tworzenie dokumentacji do oprogramowania wymaga wiedzy technicznej, szczególnie jeśli pracujesz w modelu docs as code. Natomiast trudno jest określić jaki poziom tej wiedzy powinien być. Czy jeśli pracuję z deweloperami to muszę znać ich narzędzia prawie tak samo dobrze jak oni? Czy wręcz odwrotnie - mogę się w ogóle nimi nie przejmować? Jak zwykle prawda leży po ś...

Od 2017 roku, na portalu techwriter.pl prowadzimy coroczne badanie płac. Po zebraniu odpowiedzi, publikujemy analizę wyników, która pozwala technoskrybom zobaczyć jak kształtuje się rynek komunikacji technicznej w Polsce pod kątem zarobków. W momencie publikacji tego odcinka, ankieta za rok 2025 jest wciąż otwarta, ale my już teraz postanowiliśmy przyjrzeć się odpowiedziom, które do tej pory udało...

Application Programming Interface (API) pozwala na komunikację pomiędzy programami. Ma ściśle określone reguły, które mówią nam w jaki sposób możemy zażądać informacji od jakiejś aplikacji i czego możemy spodziewać się w odpowiedzi. Czy taka wiedza jest potrzebna Tech Writerom? Według nas jak najbardziej, szczególnie jeśli tworzą dokumentację dla deweloperów. Ten odcinek to podsumowanie wiedzy jak...

Każdy z nas może zmienić świat na lepsze. Jednym ze sposobów jest na pewno udział w projekcie "Hakersi", którego celem jest wyrównywanie szans edukacyjnych i wspieranie w usamodzielnianiu się poprzez naukę nowych technologii i rozwijanie przydatnych kompetencji. Angażując się w ten projekt masz realny wpływ na życie młodych ludzi z placówek opiekuńczo-wychowawczych, pieczy zastępczej i świetlic śr...

"Feedback" to takie ciekawe, pojemne i skomplikowane zagadnienie. Po pierwsze, ciężko je przetłumaczyć dobrze na język polski. Niestety, słowa takie jak "krytyka", "recenzja" albo "opinia" nie niosą ze sobą takiego ładunku jak oryginał. Po drugie, zarówno dawanie jak i przyjmowanie feedbacku we właściwy sposób to nie lada sztuka, którą nie łatwo jest opanować. Ta z pozoru prosta czynność ma tak wi...

Zapewne każdy programista zna albo przynajmniej słyszał o Visual Studio Code (VS Code), czyli darmowym edytorze ze stajni Microsoftu. Jednak podejrzewamy, że nie każdy Tech Writer wie co to za narzędzie i że można go z powodzeniem używać do tworzenia dokumentacji. Raczej nie przyda nam się jeśli pracujemy z narzędziami typu CCMS, ale za to doskonale sprawdzi się w modelu "docs as code", w którym n...

Cały rok pracujesz w pocie czoła w przekonaniu, że Twoja praca ma sens i generuje wartość dla firmy. Zapewne masz rację, ale nie oznacza to, że osoby usytuowane wyżej w hierarchii są tego świadome i rozumieją złożoność tego z czym musisz się mierzyć na co dzień. Dlatego szefostwo organizuje wszelkiej maści spotkania i prezentacje, szczególnie na koniec roku fiskalnego, które są dla Ciebie niepowta...

Od niedawna mamy możliwość korzystania w pracy z pomocy sztucznej inteligencji, a konkretnie GitHub Copilota. Rozmawiamy o tym jak działa to narzędzie, jakie ma możliwości i w jaki sposób zmienia naszą pracę. Omawiamy konkretne przykłady zastosowania drugiego pilota w kodowaniu i tworzeniu dokumentacji i staramy się ocenić czy w ogólnym rozrachunku jest on dla nas pomocą, utrudnieniem czy zagrożen...

Co mają ze sobą wspólnego wędkarze i technoskryby? I nie chodzi o nam o słowo "ryby". To, że mogą stworzyć społeczność, która będzie się spotykać, wymieniać doświadczeniami i wspierać w trudnych momentach. Ale jak sprawić, żeby taka społeczność powstała? Odpowiedź wydaje się prosta - dać ludziom przestrzeń do spotkań, zrobić prezentację i nakarmić. Jednak w rzeczywistości wymaga to zdecydowanie wi...

Mówi się, że zanim zaczniemy biegać musimy nauczyć się chodzić. W tej mądrości ludowej kryje się wiele prawdy, którą można zastosować do nauki jakiegokolwiek zagadnienia, np. systemu kontroli wersji Git. Powierzchowna znajomość Gita i jego najpopularniejszych komend może nam zapewnić spokój na całkiem długi czas, ale w pewnym momencie zaczniemy dostrzegać trudności w radzeniu sobie z pewnymi sytua...

Naszym zdaniem otwarty umysł to bardzo przydatna cecha. Idea otwartości w połączeniu z działaniem na rzecz wspólnego dobra to nic innego jak "open source". Projekty z obszaru wolnego i otwartego oprogramowania przynoszą wielu organizacjom i jednostkom niebagatelne korzyści. Pomimo tego, że większość z nas jest świadoma ich ogromnej wartości, zazwyczaj borykają się one z problemem braku rąk do prac...

W komunikacji technicznej (i nie tylko) występuje zjawisko ustrukturyzowanego tworzenia treści, czyli "structured writing" albo jak kto woli "structured authoring". Cała idea sprowadza się do stworzenia zasad, które są potem stosowane w trakcie pisania. Poprzez narzucenie takich ściśle określonych reguł jesteśmy w stanie dostarczać treść, która jest lepszej jakości i którą nasi odbiorcy są w stani...

Kiedy Tech Writer nie koduje, zaczyna rozważać nad swoją egzystencją, a dokładniej nad tym jaką unikalną wartość wnosi jego praca. Nie jest łatwo odpowiedzieć na pytanie jakie jest clou pracy Tech Writera, dlatego o pomoc poprosiliśmy Aleksandrę Wieczorek-Konieczko, która ma kilka lat różnorodnego doświadczenia w branży komunikacji technicznej i sporo przemyśleń na ten temat. Wspólnie zastanawiamy...

Rok 2024 w komunikacji technicznej i w naszej pracy obfitował w ciekawe wydarzenia i projekty. Na naszych oczach powstawały nowe organizacje i inicjatywy, tworzyły się nowe trendy, a rzeczywistość technologiczna zmusiła nas do eksplorowania różnych rozwiązań. Krótko mówiąc, działo się! Dlatego, podążając za trendem wyznaczonym przez Spotify, postanowiliśmy stworzyć tech commowy Wrapped. Jest to na...

W przeszłości wielokrotnie dzieliliśmy się naszymi przemyśleniami na temat docs as code i CCMSów. Dlatego zamiast po raz kolejny głosić nasze zamiłowanie do rozwiązań niepochodzących od vendorów, postanowiliśmy zapytać innych o ich doświadczenia. Udało nam się znaleźć kilka osób, które uczestniczyły w migracji z CCMSa do docs as code i zgodziły się nam opowiedzieć o tym czy nowe rozwiązanie okazał...

Prawie rok temu zabraliśmy się za wdrożenie semantic searcha. Byliśmy bardzo podekscytowani tym projektem, bo po długich miesiącach teoretyzowania na ten temat wreszcie udało nam się stworzyć rozwiązanie pilotażowe, które mogliśmy pokazać testowej grupie użytkowników. Zgodnie z obietnicą złożoną w odcinku 61. wracamy do tego projektu. Rozmawiamy o tym jak się potoczyły jego losy, jakie były wyniki...

Po prawie 5 latach, ponownie zagościła u nas Agata Rygielska. Tym razem rozmawialiśmy o jej drodze od tłumaczki do kodującej Tech Writerki. Agata opowiedziała nam dlaczego postanowiła rozwijać swoje umiejętności techniczne, jakich języków i technologii się uczyła, w jaki sposób nabywała wiedzę, jakie były dla niej największe wyzwania oraz jakie ma plany na przyszłość. Na koniec dzielimy się wynika...

Pisanie dobrej dokumentacji dla deweloperów oprócz wysoko rozwiniętego warsztatu językowego wymaga również umiejętności technicznych, takich jak kodowanie. Czy teoretyczna znajomość pewnych zagadnień jest wystarczająca czy trzeba również posiadać doświadczenie praktyczne? Rozmawiamy o tym jak bardzo zaawansowane umiejętności techniczne powinien posiadać technoskryba w świecie rozwoju oprogramowani...

Pisanie dokumentacji jest trudne, co do tego nie mamy wątpliwości. Programiści nie raz w swojej karierze napotykają sytuację, w której muszą opisać jakąś procedurę lub stworzyć README. O ile aktualizacja istniejącej dokumentacji jest do przejścia, to napisanie czegoś od zera może wydawać się zadaniem nie do wykonania. Czy na pewno? Okazuje się, że deweloperzy mogą wiedzieć więcej o pisaniu dokumen...

Próbki kodu to kluczowy element dokumentacji, a w szczególności dokumentacji dla deweloperów. Dlatego uważamy, że "foo", "bar" i "baz" muszą odejść. Jako kodujący Tech Writerzy spotykamy się zarówno z dobrymi jak i kiepskimi przykładami, dlatego postanowiliśmy podsumować naszą wiedzę i doświadczenia w tym zakresie i zastanowić się jak tworzyć próbki, które są pomocne i łatwe do zrozumienia. Rozmaw...

W tym miesiącu nasz podcast obchodzi 5. urodziny. Przez ten czas nagraliśmy ponad 60 odcinków, w których rozmawialiśmy o wielu rzeczach związanych z techniczną stroną tworzenia dokumentacji, ale nigdy o tym co się dzieje za kotarą, o naszych tajnikach i technikach. Dlatego z okazji jubileuszu, postanowiliśmy opowiedzieć Wam dlaczego w ogóle zaczęliśmy nagrywać, skąd czerpiemy pomysły, czy pracujem...