Artwork

Treść dostarczona przez Doc Developer. Cała zawartość podcastów, w tym odcinki, grafika i opisy podcastów, jest przesyłana i udostępniana bezpośrednio przez Doc Developer lub jego partnera na platformie podcastów. Jeśli uważasz, że ktoś wykorzystuje Twoje dzieło chronione prawem autorskim bez Twojej zgody, możesz postępować zgodnie z procedurą opisaną tutaj https://pl.player.fm/legal.
Player FM - aplikacja do podcastów
Przejdź do trybu offline z Player FM !

#24 Tech Writer publikuje inaczej, czyli API do dokumentacji

30:43
 
Udostępnij
 

Manage episode 280772238 series 2508014
Treść dostarczona przez Doc Developer. Cała zawartość podcastów, w tym odcinki, grafika i opisy podcastów, jest przesyłana i udostępniana bezpośrednio przez Doc Developer lub jego partnera na platformie podcastów. Jeśli uważasz, że ktoś wykorzystuje Twoje dzieło chronione prawem autorskim bez Twojej zgody, możesz postępować zgodnie z procedurą opisaną tutaj https://pl.player.fm/legal.

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></p> <p>Progressive Web Application: <a href="https://">https://en.wikipedia.org/wiki/Progressive_web_application</a></p> <p>"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></p> <p>Elastic (Elasticsearch, Kibana): <a href="https://">https://www.elastic.co/</a></p> <p>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></p> <p>Adobe FrameMaker: <a href="//">https://pl.wikipedia.org/wiki/Adobe_FrameMaker</a></p> <p>Markdown: <a href="https://daringfireball.net/projects/markdown/syntax">https://daringfireball.net/projects/markdown/syntax</a></p> <p>Gatsby: <a href="https://">https://www.gatsbyjs.com/</a></p> <p>GraphQL: <a href="//">https://graphql.org/</a></p> <p>React: <a href="https://">https://pl.reactjs.org/</a></p>

  continue reading

64 odcinków

Artwork
iconUdostępnij
 
Manage episode 280772238 series 2508014
Treść dostarczona przez Doc Developer. Cała zawartość podcastów, w tym odcinki, grafika i opisy podcastów, jest przesyłana i udostępniana bezpośrednio przez Doc Developer lub jego partnera na platformie podcastów. Jeśli uważasz, że ktoś wykorzystuje Twoje dzieło chronione prawem autorskim bez Twojej zgody, możesz postępować zgodnie z procedurą opisaną tutaj https://pl.player.fm/legal.

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></p> <p>Progressive Web Application: <a href="https://">https://en.wikipedia.org/wiki/Progressive_web_application</a></p> <p>"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></p> <p>Elastic (Elasticsearch, Kibana): <a href="https://">https://www.elastic.co/</a></p> <p>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></p> <p>Adobe FrameMaker: <a href="//">https://pl.wikipedia.org/wiki/Adobe_FrameMaker</a></p> <p>Markdown: <a href="https://daringfireball.net/projects/markdown/syntax">https://daringfireball.net/projects/markdown/syntax</a></p> <p>Gatsby: <a href="https://">https://www.gatsbyjs.com/</a></p> <p>GraphQL: <a href="//">https://graphql.org/</a></p> <p>React: <a href="https://">https://pl.reactjs.org/</a></p>

  continue reading

64 odcinków

Wszystkie odcinki

×
 
Loading …

Zapraszamy w Player FM

Odtwarzacz FM skanuje sieć w poszukiwaniu wysokiej jakości podcastów, abyś mógł się nią cieszyć już teraz. To najlepsza aplikacja do podcastów, działająca na Androidzie, iPhonie i Internecie. Zarejestruj się, aby zsynchronizować subskrypcje na różnych urządzeniach.

 

Skrócona instrukcja obsługi