:: ::

Pisanie dokumentacji do API to dziedzina sama w sobie, która w dzisiejszych czasach zyskuje na znaczeniu. Przyspieszony rozwój technologii cyfrowych w dobie pandemii i pracy zdalnej podniósł znaczenie dokumentacji w ogóle, a dokumentacji do API w szczególności. Z naszymi gośćmi, Jadwigą Sitnicką z LogMeIn, Mateuszem Wiktorem z PubNub i Pawłem Krentowskim z Ocado Technology, rozmawiamy m.in. o tym z jakich elementów składa się dokumentacja do API, kto i w jaki sposób tworzy poszczególne części, jakie są najczęstsze problemy i wyzwania podczas tworzenia tego typu dokumentacji oraz jakie narzędzia warto znać. Muzyka w intro oraz dźwięki 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 . Informacje dodatkowe: Application Programming Interface (API): https://pl.wikipedia.org/wiki/Interfejs_programowania_aplikacji LogMeIn: https://www.logmein.com/ Ocado Technology: https://www.ocadogroup.com/technology/technology-pioneers PubNub: https://www.pubnub.com/ "The State of API Report 2020": https://smartbear.com/resources/ebooks/the-state-of-api-2020-report/ Markdown: https://daringfireball.net/projects/markdown/syntax ReadMe.io: https://readme.com/ Stoplight Studio: https://stoplight.io/studio/ OpenAPI: https://www.openapis.org/ Swagger UI: https://swagger.io/tools/swagger-ui/ ReDoc: https://github.com/Redocly/redoc Jekyll: https://jekyllrb.com/ GitLab: https://about.gitlab.com/ curl: https://curl.se/ Postman: https://www.postman.com/ Visual Studio Code: https://code.visualstudio.com/ Software Development Kit (SDK): https://pl.wikipedia.org/wiki/Software_development_kit Integrated Development Environment (IDE):  https://pl.wikipedia.org/wiki/Zintegrowane_%C5%9Brodowisko_programistyczne "Wstęp do REST API": https://devszczepaniak.pl/wstep-do-rest-api/ Grupa "Tworzenie dokumentacji" na Facebooku: https://www.facebook.com/groups/tworzeniedokumentacji

Jest to odcinek podkastu:
Tech Writer koduje

Podcast o technicznej stronie tworzenia dokumentacji w IT. Skupiamy się na tym jak Tech Writer może wpasować się w środowisko programistów zarówno pod kątem sposobu pracy jak i używanych technologii, narzędzi i rozwiązań. Staramy się też pokazać, że praca Tech Writera może być ciekawa i rozwijająca pod kątem umiejętności technicznych.

Kategorie:
Technologia

Informacja dotycząca prawa autorskich: Wszelka prezentowana tu zawartość podkastu jest własnością jego autora

Wyszukiwanie

Kategorie