#26 Tech Writerzy dokumentuja API

Published: Feb. 10, 2021, 2:04 p.m.

b'

Pisanie dokumentacji do API to dziedzina sama w sobie, kt\\xf3ra w dzisiejszych czasach zyskuje na znaczeniu. Przyspieszony rozw\\xf3j technologii cyfrowych w dobie pandemii i pracy zdalnej podni\\xf3s\\u0142 znaczenie dokumentacji w og\\xf3le, a dokumentacji do API w szczeg\\xf3lno\\u015bci.

\\n

Z naszymi go\\u015b\\u0107mi, Jadwig\\u0105 Sitnick\\u0105 z LogMeIn, Mateuszem Wiktorem z PubNub i Paw\\u0142em Krentowskim z Ocado Technology, rozmawiamy m.in. o tym z jakich element\\xf3w sk\\u0142ada si\\u0119 dokumentacja do API, kto i w jaki spos\\xf3b tworzy poszczeg\\xf3lne cz\\u0119\\u015bci, jakie s\\u0105 najcz\\u0119stsze problemy i wyzwania podczas tworzenia tego typu dokumentacji oraz jakie narz\\u0119dzia warto zna\\u0107.

\\n

Muzyka w intro oraz d\\u017awi\\u0119ki pochodz\\u0105 z kolekcji "107 Free Retro Game Sounds" dost\\u0119pnej na stronie https://dominik-braun.net, udost\\u0119pnianej na podstawie licencji Creative Commons license CC BY 4.0.

\\n

Informacje dodatkowe:

\\n

Application Programming Interface (API): https://pl.wikipedia.org/wiki/Interfejs_programowania_aplikacji

\\n

LogMeIn: https://www.logmein.com/

\\n

Ocado Technology: https://www.ocadogroup.com/technology/technology-pioneers

\\n

PubNub: https://www.pubnub.com/

\\n

"The State of API Report 2020": https://smartbear.com/resources/ebooks/the-state-of-api-2020-report/

\\n

Markdown: https://daringfireball.net/projects/markdown/syntax

\\n

ReadMe.io: https://readme.com/

\\n

Stoplight Studio: https://stoplight.io/studio/

\\n

OpenAPI: https://www.openapis.org/

\\n

Swagger UI: https://swagger.io/tools/swagger-ui/

\\n

ReDoc: https://github.com/Redocly/redoc

\\n

Jekyll: https://jekyllrb.com/

\\n

GitLab: https://about.gitlab.com/

\\n

curl: https://curl.se/

\\n

Postman: https://www.postman.com/

\\n

Visual Studio Code: https://code.visualstudio.com/

\\n

Software Development Kit (SDK): https://pl.wikipedia.org/wiki/Software_development_kit

\\n

Integrated Development Environment (IDE): https://pl.wikipedia.org/wiki/Zintegrowane_%C5%9Brodowisko_programistyczne

\\n

"Wst\\u0119p do REST API": https://devszczepaniak.pl/wstep-do-rest-api/

\\n

Grupa "Tworzenie dokumentacji" na Facebooku: https://www.facebook.com/groups/tworzeniedokumentacji

'