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/

"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 wiele ruchomych części, które mogą wskoczyć na niewłaściwe miejsce powodując różnej maści problemy.

Do rozmowy na temat feedbacku zaprosiliśmy naszą znajomą po fachu Aleksandrę Wieczorek-Konieczko, która obecnie realizuje się jako konsultantka "uzdrawiająca dokumentację" (DocDoctor). Analizujemy to zagadnienie z perspektywy sytuacji, które często występują w branży IT starając się znaleźć odpowiedź na pytanie "Jak to robić dobrze?".

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:

• "Doktorka od dokumentacji: Rozmowa z Olą o tech writingu i łączeniu kreatywności z wiedzą techniczną", Freelance Superstars: https://creators.spotify.com/pod/profile/freelancesuperstars/episodes/Doktorka-od-dokumentacji-Rozmowa-z-Ol-o-tech-writingu-i-czeniu-kreatywnoci-z-wiedz-techniczn-e38rvui/a-ac6c822
• "#74 Tech Writer poszukuje clou swojej pracy, czyli za co nam płacą", Tech Writer Koduje: https://techwriterkoduje.pl/blog/2025/1/29/74/
• "About pull requests", GitHub: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
• CAKE conf: https://cakeconf.contentbytes.pl/
• "Syndrom oszusta", Wikipedia: https://pl.wikipedia.org/wiki/Syndrom_oszusta
• Aleksandra Wieczorek-Konieczko, LinkedIn: https://www.linkedin.com/in/techwriter-wieczorek/
• DocDoctor: https://www.doc-doctor.org/

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 niepodzielnie od wielu lat króluje Markdown. Mnogość opcji konfiguracyjnych i dostępnych wtyczek sprawia, że ten edytor może okazać się świetnym wyborem dla technoskrybów, którzy ściśle współpracują z programistami.

Rozmawiamy o tym co nam oferuje VS Code, jakie wtyczki przydają się do pisania dokumentacji, jakie ciekawe funkcje można znaleźć w tym edytorze, a nawet o tym jak dodać podstawowe wsparcie dla plików DITA.

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:

• Visual Studio Code (VS Code): https://code.visualstudio.com/https://code.visualstudio.com/
• Wtyczka MDX: https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx

• Wtyczka Markdown All in One: https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one
• Wtyczka markdownlint: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
• Wtyczka Markdown Preview Enhanced: https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced
• Vale: https://github.com/errata-ai/vale
• Wtyczka Vale VSCode: https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode
• Wtyczka Write Good Linter: https://marketplace.visualstudio.com/items?itemName=travisthetechie.write-good-linter
• Wtyczka vscode-textlint: https://marketplace.visualstudio.com/items?itemName=taichi.vscode-textlint
• Wtyczka Prettier - Code formatter: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
• Wtyczka Code Spell Checker: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
• Wtyczka Markdown PDF: https://marketplace.visualstudio.com/items?itemName=yzane.markdown-pdf
• Wtyczka Gremlins tracker for Visual Studio Code: https://marketplace.visualstudio.com/items?itemName=nhoizey.gremlins
• Wtyczka REST Client: https://marketplace.visualstudio.com/items?itemName=humao.rest-client
• Wtyczka GitLens — Git supercharged: https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens

• "Lint, Lint and Away! Linters for the English Language", Chris Chinchilla: https://hackernoon.com/lint-lint-and-away-linters-for-the-english-language-70f4b22cc73c
• "The 2025 Developer Survey", Stack Overflow: https://survey.stackoverflow.co/2025

• "Darwin Information Typing Architecture" (DITA), Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
• "How can I make DITA catalog.xml work in VS Code?", Stack Overflow: https://stackoverflow.com/questions/64782816/how-can-i-make-dita-catalog-xml-work-in-vs-code

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 niepowtarzalną szansą na przedstawienie swojego bogatego dorobku.

Rozmawiamy o tym jak pokazać przełożonym wartość swojej pracy, tak żeby po 5 minutach nie stracili zainteresowania, na ile głęboko powinniśmy wchodzić w szczegóły techniczne i jakie cyferki mają znaczenie. W pierwszej części omawiamy wspomniane zagadnienia z punktu widzenia Doc Tools Developera, a w drugiej z punktu widzenia Tech Writera.

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/).

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żeniem.

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/).

Informacje dodatkowe:

• GitHub Copilot: https://github.com/features/copilot
• "Agentic AI", Wikipedia: https://en.wikipedia.org/wiki/Agentic_AI
• "Darwin Information Typing Architecture", Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
• "AI Changes Everything", Armin Ronacher: https://lucumr.pocoo.org/2025/6/4/changes/
• "My AI Skeptic Friends Are All Nuts", Thomas Ptacek: https://fly.io/blog/youre-all-nuts/
• "Agent AI - kopilot dla tech writera", Paweł Kowaluk: https://techwriter.pl/copilot-dla-tech-writera
• "#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

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ęcej wysiłku.

Rozmawiamy z Edytą Rakowską i Basią Czyż z Content Bytes o cieniach i blaskach organizowania meetupów dla specjalistów zajmujących się szeroko pojętą treścią, o tym co je motywuje do działania, dlaczego warto dołączyć jako uczestnik i prelegent oraz o ich planach na przyszłość.

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/).

Informacje dodatkowe:

• Content Bytes: https://contentbytes.pl/
• CAKE Conf: https://cakeconf.contentbytes.pl/
• Content Bytes #04 - "Let's talk language": https://contentbytes.pl/events/2025/4
• Michał Olender, LinkedIn: https://www.linkedin.com/in/michal-olender/
• Paweł Chłodnicki, LinkedIn: https://www.linkedin.com/in/pawelchlodnicki/
• Tomasz Prus, LinkedIn: https://www.linkedin.com/in/tomasz-prus-4b09b01a/
• Slack: https://slack.com/
• Linear: https://linear.app/

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 sytuacjami. Niechlujne wpisy w historii zmian na pewno utrudnią nam ustalenie kto, kiedy i dlaczego coś zmienił, a brak znajomości podstawowych zagadnień i mechaniki Gita spowoduje, że nieraz poczujemy się zagubieni i bezradni.

Rozmawiamy o tym jak zadbać o to, żeby nasza historia zmian była jasna i przejrzysta, a przez to przydatna i z jakiego zakresu uzupełnić wiedzę teoretyczną o Gicie, a także dzielimy się wskazówkami na temat przydatnych ustawień i komend.

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/).

Informacje dodatkowe:

• Git: https://git-scm.com/
• "How to Write a Git Commit Message", cbeams: https://cbea.ms/git-commit/
• "Git turns 20: A Q&A with Linus Torvalds", GitHub: https://github.blog/open-source/git/git-turns-20-a-qa-with-linus-torvalds/
• "How did Git get its name?", Initial Commit: https://initialcommit.com/blog/How-Did-Git-Get-Its-Name
• Conventional Commits: https://www.conventionalcommits.org/en/v1.0.0/
• "Darwin Information Typing Architecture (DITA)", Wikipedia: https://pl.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
• "Git Squash Commits: A Guide With Examples", DataCamp: https://www.datacamp.com/tutorial/git-squash-commits
• "How to Create and Push an Empty Commit in Git", Tower FAQ: https://www.git-tower.com/learn/git/faq/git-empty-commit
• "8.1 Customizing Git - Git Configuration", Git: https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration