#24 Tech Writer publikuje inaczej, czyli API do dokumentacji

Tech Writer koduje

Контент предоставлен Michał Skowron i Paweł Kowaluk, Michał Skowron, and Paweł Kowaluk. Весь контент подкастов, включая эпизоды, графику и описания подкастов, загружается и предоставляется непосредственно компанией Michał Skowron i Paweł Kowaluk, Michał Skowron, and Paweł Kowaluk или ее партнером по платформе подкастов. Если вы считаете, что кто-то использует вашу работу, защищенную авторским правом, без вашего разрешения, вы можете выполнить процедуру, описанную здесь https://ru.player.fm/legal.

4y ago 30:43

MP3•Главная эпизода

Niektóre sposoby publikowania dokumentacji są znane wśród Tech Writerów od zarania dziejów. Portale serwujące wszelakiej maści treści w formacie HTML czy PDF są niejako standardem branżowym. W sytuacji kiedy odbiorcą dokumentacji jest użytkownik produktu te formy spełniają swoje zadanie. Ale co zrobić kiedy do naszej dokumentacji potrzebuje się dobrać jakaś aplikacja? Na przykład, aplikacja webowa chce wyświetlić dokumentację w panelu, który jest jej integralną cześcią. Możemy wtedy zastosować stary dobry "iframe", jednak takie rozwiązanie nie jest zalecane, a do tego stwarza szereg problemów. A może by tak stworzyć API dla dokumentacji i serwować treść za pomocą endpointów? Rozważamy czy takie rozwiązanie jest możliwe, czy ma sens i w jakich sytuacjach mogłoby się sprawdzić.

Informacje dodatkowe:

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

Tag : <a href="//">https://www.w3schools.com/tags/tag_iframe.ASP</a> Progressive Web Application: <a href="https://">https://en.wikipedia.org/wiki/Progressive_web_application</a> "Co zmieniają Progressive Web Applications? Wszystko, co musisz wiedzieć o PWA": <a href="https://">https://www.e-point.pl/blog/co-zmieniaja-progressive-web-applications-wszystko-co-musisz-wiedziec-o-pwa</a> Elastic (Elasticsearch, Kibana): <a href="https://">https://www.elastic.co/</a> Standard DITA (Darwin Information Typing Architecture): <a href="https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture">https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture</a> Adobe FrameMaker: <a href="//">https://pl.wikipedia.org/wiki/Adobe_FrameMaker</a> Markdown: <a href="https://daringfireball.net/projects/markdown/syntax">https://daringfireball.net/projects/markdown/syntax</a> Gatsby: <a href="https://">https://www.gatsbyjs.com/</a> GraphQL: <a href="//">https://graphql.org/</a> React: <a href="https://">https://pl.reactjs.org/</a>

73 эпизодов

#Doc Developer #Technologie