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 zostały rozwiązane dawno temu i nie ma sensu rozwiązywać ich ponownie za pomocą LLMów. W tym odcinku rozmawiamy o narzędziach i rozwiązaniach "starego" typu, które mogą nam pomóc w procesie tworzenia dokumentacji. Poszukujemy złotego środka, który pozwala na mariaż starej i nowej rzeczywistości.

Dźwięki wykorzystane w audycji pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).

Linki:

• "Token maxxing", Wikipedia: https://en.wikipedia.org/wiki/Token_maxxing
• "Lint, Lint and Away! Linters for the English Language", Chris Ward: https://dzone.com/articles/lint-lint-and-away-linters-for-the-english-languag
• Visual Studio (VS) Code: https://code.visualstudio.com/
• IntelliJ IDEA: https://www.jetbrains.com/idea/
• Code Spell Checker: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
• Gremlins tracker: https://github.com/nhoizey/vscode-gremlins
• Alex: https://alexjs.com/
• Write Good Linter: https://github.com/TravisTheTechie/vscode-write-good#readme
• textlint: https://github.com/textlint/vscode-textlint
• LanguageTool: https://languagetool.org/pl
• Hemingway Editor: https://hemingwayapp.com/
• Vale: https://vale.sh/
• Grazie: https://www.jetbrains.com/grazie/
• Schematron: https://www.schematron.com/
• "Readability – what is it and how do I improve it?", Paweł Kowaluk (soap! 2018): https://www.youtube.com/watch?v=LzrHrIOHhz8
• "Automated readability index", Wikipedia: https://en.wikipedia.org/wiki/Automated_readability_index
• Simplified Technical English: https://www.asd-ste100.org/
• "Standard DITA (Darwin Information Typing Architecture)", Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
• MDX: https://mdxjs.com/

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 of the Technical Writer role, technological shifts in the last several decades that affected the process of writing documentation and challenges that women have to face in the IT industry.

Sounds used in this episode are part of the "107 Free Retro Game Sounds" collection, which is available at https://dominik-braun.net and shared under the Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).

Show notes:

• "Women in Technical Communication", Sharon Burton,: https://www.sharonburton.com/
• The Society for Technical Communication (STC): https://en.wikipedia.org/wiki/Society_for_Technical_Communication
• Tekom: https://www.technical-communication.org/
• MadCap Flare: https://www.madcapsoftware.com/products/flare/
• "Docs as Tests & AI", Manny Silva: https://www.docsastests.com/docs-as-tests-book/
• Topic-based authoring: https://www.madcapsoftware.com/blog/what-is-topic-based-authoring/
• CAKE Conf: https://cakeconf.contentbytes.pl/
• "Darwin Information Typing Architecture (DITA)", Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
• "Docs as Code", Write the Docs: https://www.writethedocs.org/guide/docs-as-code/
• Write the Docs (WTD): https://www.writethedocs.org/
• “Everybody Lies: Big Data, New Data, and What the Internet Can Tell Us About Who We Really Are”, Seth Stephens-Davidowitz: https://www.goodreads.com/en/book/show/28512671-everybody-lies

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 - od pomysłu do implementacji.

Dźwięki wykorzystane w audycji pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).

Linki:

• "Jak wybierać narzędzia?", techwriter.pl: https://techwriter.pl/jak-wybierac-narzedzia
• "Wdrażanie narzędzia w organizacji - szybki kurs pilotażu", techwriter.pl: https://techwriter.pl/szybki-kurs-pilotazu
• Syllabus ITCQF: https://www.gasq.org/files/content/gasq/downloads/certification/ITCQF/ITCQF_Syllabus_v2_0Jun2020.pdf

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 ponadczasowa. Rozmawiamy o tym jak sztuczna inteligencja wpływa na model pracy Tech Writera, co można zrobić przy pomocy dostępnych na tę chwilę narzędzi i jak zmienić podejście do pewnych kwestii związanych z tworzeniem dokumentacji, żeby wycisnąć ile się da z tej kolejnej już rewolucji technologicznej.

Dźwięki wykorzystane w audycji pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).

Linki:

• "Context engineering vs. prompt engineering: Key differences explained", Glean: https://www.glean.com/perspectives/context-engineering-vs-prompt-engineering-key-differences-explained
• "What is agentic AI?", IBM: https://www.ibm.com/think/topics/agentic-ai
• Agent Skills: https://agentskills.io/home
• "Writing a good CLAUDE.md", HumanLayer Blog: https://www.humanlayer.dev/blog/writing-a-good-claude-md
• "New habits for tech writers in the age of LLMs", passo.uno: https://passo.uno/new-habits-tech-writers-ai-age/
• "The writing was always the cheap part", passo.uno: https://passo.uno/real-cost-of-documentation/
• GitHub Copilot: https://github.com/features/copilot
• Claude Code: https://claude.com/product/claude-code
• Elasticsearch: https://www.elastic.co/elasticsearch
• "AI slop", Wikipedia: https://en.wikipedia.org/wiki/AI_slop
• "Darwin Information Typing Architecture (DITA)", Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
• Oxygen XML Editor: https://www.oxygenxml.com/
• Oxygen AI Positron: https://www.oxygenxml.com/ai_positron.html
• "#57 Tech Writer zostaje Prompt Engineerem, czyli nowa potencjalna ścieżka kariery dla technoskryby", Tech Writer Koduje: https://techwriterkoduje.pl/blog/2023/8/28/57/

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 środku. Powinno się znać te narzędzia na tyle na ile jest to potrzebne, żeby być lepszym technoskrybą - nie bardziej i nie mniej. W naszej rozmowie poszukujemy tego środka i dzielimy się naszymi praktycznymi wskazówkami, które sprawią, że zdobywanie wiedzy technicznej stanie się tylko środkiem do osiągnięcia Twojego celu a nie celem samym w sobie.

Dźwięki wykorzystane w audycji pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).

Linki:

• Arbortext: https://www.ptc.com/en/products/arbortext
• "Docs as Code", Write the Docs: https://www.writethedocs.org/guide/docs-as-code/
• "Jak pracować z narzędziami deweloperskimi - wskazówki dla tech writerów", techwriter.pl: https://techwriter.pl/jak-pracowac-z-narzedziami-nie-bedac-programista
• IntelliJ IDEA: https://www.jetbrains.com/idea/
• "Git (oprogramowanie)", Wikipedia: https://pl.wikipedia.org/wiki/Git_(oprogramowanie)
• Markdown: https://daringfireball.net/projects/markdown/syntax
• "Kurde! Reuse popsuł mi searcha", techwriter.pl: https://techwriter.pl/reuse-zly-dla-searcha/
• "Terminal", Filmweb: https://www.filmweb.pl/film/Terminal-2004-106408
• Visual Studio (VS) Code: https://code.visualstudio.com
• "CI/CD", Wikipedia: https://en.wikipedia.org/wiki/CI/CD
• "Wiersz poleceń", Wikipedia: https://pl.wikipedia.org/wiki/Wiersz_polece%C5%84
• Oxygen XML: https://www.oxygenxml.com/
• "Darwin Information Typing Architecture" (DITA), Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
• AsciiDoc: https://asciidoc.org/
• reStructuredText: http://docutils.sourceforge.net/rst.html
• Static site generator: https://www.gatsbyjs.com/docs/glossary/static-site-generator/
• DITA Open Toolkit (DITA OT): https://www.dita-ot.org/
• "Component content management system (CCMS)", Wikipedia: https://en.wikipedia.org/wiki/Component_content_management_system
• Jamstack: https://jamstack.org/
• Yarn: https://yarnpkg.com/
• "What is Amazon S3", Amazon docs: https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html
• Wtyczka Prettier - Code formatter: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
• Wtyczka GitLens — Git supercharged: https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens
• Wtyczka Code Spell Checker: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
• "API", Wikipedia: https://en.wikipedia.org/wiki/API
• Wtyczka REST Client: https://marketplace.visualstudio.com/items?itemName=humao.rest-client
• Postman API client: https://www.postman.com/product/api-client/
• cURL: https://curl.se/
• „Ciemność, widzę ciemność, ciemność widzę - czyli jak poskromić linię komend", techwriter.pl: https://techwriter.pl/linia-komend

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 się nam zebrać. "Na gorąco" komentujemy wyniki i staramy się wyciągnąć z nich jakieś wnioski.

Dźwięki wykorzystane w audycji pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).

Linki:

• "Dziobak australijski", Wikipedia: https://pl.wikipedia.org/wiki/Dziobak_australijski
• "Wyniki badania płac w komunikacji technicznej 2024", techwriter.pl: https://techwriter.pl/wyniki-badania-plac-w-komunikacji-technicznej-2024/

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ą przekazaliśmy uczestnikom podczas darmowych warsztatów "Using REST APIs for Technical Writers", które przeprowadziliśmy 28.11.2025 przy współpracy z Content Bytes.

Rozmawiamy o tym czym jest API, jak sformułować żądanie, które pozwoli nam otrzymać odpowiedź, jakie typy żądań i odpowiedzi istnieją, jakich narzędzi możemy użyć i o innych podstawach, które ułatwią technoskrybom wejście w świat interakcji z aplikacjami poprzez API.

Dźwięki wykorzystane w audycji pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).

Linki:

• CAKE conf: https://cakeconf.contentbytes.pl/
• "API", Wikipedia: https://en.wikipedia.org/wiki/API
• "What Is a REST API? Examples, Uses, and Challenges", Postman Blog: https://blog.postman.com/rest-api-examples/
• "SOAP", Wikipedia: https://en.wikipedia.org/wiki/SOAP
• Swagger UI: https://swagger.io/tools/swagger-ui/
• OpenAPI: https://www.openapis.org/
• cURL: https://curl.se/
• Visual Studio (VS) Code: https://code.visualstudio.com
• REST Client: https://marketplace.visualstudio.com/items?itemName=humao.rest-client
• Postman API client: https://www.postman.com/product/api-client/
• Requestly: https://requestly.com/

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 środowiskowych.

Z Katarzyną Klimek-Michno, ekspertką ds. komunikacji i PR w Fundacji Sarigato, omawiamy szczegółowo projekt "Hakersi". Z naszej rozmowy dowiecie się na czym on polega, kto za nim stoi, kto i jak może go wesprzeć, jakie są bieżące potrzeby i plany na przyszłość. Usłyszycie też inspirujące historie, które mamy nadzieję, zachęcą Was do działania.

Dźwięki wykorzystane w audycji pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).

Linki:

• Projekt "Hakersi": https://hakersi.pl/
• Fundacja Sarigato: https://sarigato.org/
• Hack4Krak: https://hack4krak.pl/
• Katarzyna Klimek-Michno, LinkedIn: https://www.linkedin.com/in/katarzyna-klimek-michno-567a7bb3/