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/