:: ::

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

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