46 episodes

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.

Tech Writer koduje Doc Developer

    • Technology

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.

    #46 Zostań hakerem w służbie pokoju, czyli o "Hack for Peace" słów kilka

    #46 Zostań hakerem w służbie pokoju, czyli o "Hack for Peace" słów kilka

    Trzy dni, pięć lokalizacji w różnych częściach Europy i jeden cel -  stworzenie produktów technologicznych, które pozwolą na rozwiązanie  problemów związanych z wojną. "Hack for Peace" to wydarzenie dla wszystkich, którzy pracują z technologią i chcieliby wykorzystać swoje umiejętności dla wspólnego dobra.

    Na koniec, jury składające się z przedstawicieli organizatorów i partnerów wybierze trzech zwycięzców, którzy będą mieli możliwość rozwijania swoich pomysłów pod opieką mentorów. Przewidziane są również nagrody pieniężne od "House of Europe".

    Posłuchajcie naszej krótkiej rozmowy z Olgą Sulik z firmy Sigma Software, w której staramy się Wam przybliżyć tę zacną ideę.

    Dźwięki wykorzystane w audycji 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 (https://creativecommons.org/licenses/by/4.0/).

    Informacje dodatkowe:


    Sigma Software: https://sigma.software/
    "Hack for Peace": https://hackforpeace.net/
    Informacja prasowa o "Hack for Peace": https://docs.google.com/document/d/1-brngt30XlNYUTnfhfMPe3QVp1ZF5U-A/edit 
    Femmegineering Meetup w Krakowie: https://www.eventbrite.co.uk/e/femmegineering-meetup-in-search-of-the-eternal-code-tickets-415343793467?aff=ebdsoporgprofile

    • 12 min
    #45 Tech Writer wybiera pomiędzy narzędziami open source a enterprise, czyli jak zbudować tech stack z przyszłością

    #45 Tech Writer wybiera pomiędzy narzędziami open source a enterprise, czyli jak zbudować tech stack z przyszłością

    Open source oznacza, że się nie płaci, prawda? Niezupełnie. Nie płaci się pieniędzmi, ale za to płaci się swoim czasem. Trzeba mieć też trochę umiejętności, żeby to ogarnąć. Dlatego może lepiej zapłacić za rozwiązanie enterprise i mieć problem z głowy. Tylko wtedy też musimy zainwestować swój czas w utrzymanie systemu, nie mówiąc już o negocjacjach z vendorem i innych trudnościach.

    Rozmawiamy o plusach i minusach rozwiązań open source i enterprise w technical writingu. Jak podejść do wyliczania kosztów? W jakich sytuacjach lepiej zdać się na vendora, a w jakich lepiej polegać na sobie. Jakie są "ukryte" koszty obu ścieżek? Jeśli stoisz przed wyborem tech stacka dla technical writingu, ten odcinek jest dla Ciebie.

    Dźwięki wykorzystane w audycji 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 (https://creativecommons.org/licenses/by/4.0/).

    Informacje dodatkowe:


    WordPress: https://wordpress.com/
    Docusaurus: https://docusaurus.io/
    Next.js: https://nextjs.org/
    Component Content Management System (CCMS): https://en.m.wikipedia.org/wiki/Component_content_management_system
    MadCap Flare: https://www.madcapsoftware.com/products/flare/#content
    Adobe RoboHelp: https://www.adobe.com/products/robohelp.html
    Snyk Advisor: https://snyk.io/advisor/
    "How one developer just broke Node, Babel and thousands of projects in 11 lines of JavaScript", The Register: https://www.theregister.com/2016/03/23/npm_left_pad_chaos/
    "Open Source Developer Sabotages npm Libraries ‘Colors,’ ‘Faker’", FOSSA: https://fossa.com/blog/npm-packages-colors-faker-corrupted/
    Stack Overflow: https://stackoverflow.com/
    Skeumorfizm: https://pl.wikipedia.org/wiki/Skeumorfizm

    • 38 min
    #44 Rekrutacja Tech Writerów w praktyce, czyli prawie wszystko co trzeba wiedzieć o rynku pracy dla technoskrybów w Polsce

    #44 Rekrutacja Tech Writerów w praktyce, czyli prawie wszystko co trzeba wiedzieć o rynku pracy dla technoskrybów w Polsce

    Rekrutacja to temat zawsze na czasie. Również wśród technoskrybów wzbudza on wiele emocji. Dlatego po ponad 2-letniej przerwie wracamy do niego razem z Michałem Słapakiem (Motorola Solutions) i Tomkiem Prusem (Atlassian).

    Przyglądamy się obecnej sytuacji na rynku pracy dla Tech Writerów w Polsce oraz procesowi rekrutacyjnemu zarówno pod kątem poziomu umiejętności aplikujących jak i oczekiwań zatrudniających. Oceniamy jak zmieniły się realia w ostatnich latach, staramy się zbudować profil kandydata, który posiada zestaw najbardziej poszukiwanych umiejętności i zastanawiamy jak trudno jest wejść w tech writing w branży IT osobom z zewnątrz.

    Dźwięki wykorzystane w audycji 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 (https://creativecommons.org/licenses/by/4.0/).

    Informacje dodatkowe:


    "#12 Tech Writer się rekrutuje, czyli jak ważne są umiejętności techniczne", Tech Writer koduje: https://techwriterkoduje.pl/blog/2020/01/20/tech-writer-sie-rekrutuje
    Motorola Solutions: https://www.motorolasolutions.com/en_xu.html
    Unit4: https://www.unit4.com/
    Atlassian: https://www.atlassian.com/
    Guidewire Software: https://www.guidewire.com/
    International Technical Communication Qualification Foundation (ITCQF): https://itcqf.org/
    Komunikacja Techniczna - studia podyplomowe (Vistula): https://www.vistula.edu.pl/kierunki-studiow/kontynuacja-edukacji/studia-podyplomowe/informatyka/komunikacja-techniczna
    Python: https://www.python.org/
    Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
    Raport "Technical writing in Central and Eastern Europe": https://itcqf.org/wp-content/uploads/2022/05/Technical-Writing-in-Central-and-Eastern-Europe.pdf
    Profil Michała Słapaka na LinkedIn: https://www.linkedin.com/in/michal-slapak-a1a2012/
    Profil Tomasza Prusa na LinkedIn: https://www.linkedin.com/in/tomasz-prus-4b09b01a/

    • 56 min
    #43 Tech Writer buduje stronę z dokumentacją, czyli prosty przepis jak zacząć od zera

    #43 Tech Writer buduje stronę z dokumentacją, czyli prosty przepis jak zacząć od zera

    Zbudowanie strony z dokumentacją od zera może się wydawać nie lada wyzwaniem. Istnieje mnóstwo sposobów na podejście do tematu. Kiedy myślimy nad potencjalnym rozwiązaniem, do głowy przychodzą nam następujące pytania:

    Czy można do tego celu użyć darmowych narzędzi? Czy istnieje coś takiego jak bezpłatny hosting? Jak pisać dokumentację bez CCMSa? Jak wygenerować PDFy bez użycia standardu DITA?

    W tym odcinku staramy się stworzyć prosty (i bardzo subiektywny) przepis, który pomoże Wam zbudować nowoczesną stronę z dokumentacją w relatywnie krótkim czasie.

    Dźwięki wykorzystane w audycji 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 (https://creativecommons.org/licenses/by/4.0/).

    Informacje dodatkowe:


    "#38 Tech Writer walczy z hakerami, czyli jak zadbać o bezpieczeństwo dokumentacji", Tech Writer koduje: https://techwriterkoduje.pl/blog/2022/01/10/tech-writer-walczy-z-hakerami
    Static Site Generator: https://www.gatsbyjs.com/docs/glossary/static-site-generator/
    Docusaurus: https://docusaurus.io/
    Algolia: https://www.algolia.com/
    Markdown: https://daringfireball.net/projects/markdown/syntax
    Visual Studio (VS) Code: https://code.visualstudio.com/
    VSCodium: https://vscodium.com/
    Rozszerzenie Vale dla VS Code: https://github.com/errata-ai/vale-vscode
    Git: https://git-scm.com/
    GitHub: https://github.com/
    GitHub Pages: https://pages.github.com/
    GitHub Actions: https://github.com/features/actions
    Repozytorium dla strony Tech Writer koduje: https://github.com/techwriterkoduje/site-source
    TeamCity: https://www.jetbrains.com/teamcity/
    Jenkins: https://www.jenkins.io/
    Kubernetes: https://kubernetes.io/
    Docker: https://www.docker.com/
    DITA Open Toolkit (OT): https://www.dita-ot.org/
    Oxygen XML: https://www.oxygenxml.com/
    mr-pdf: https://www.npmjs.com/package/mr-pdf

    • 35 min
    #42 Konferencja soap! 2022 - podsumowanie

    #42 Konferencja soap! 2022 - podsumowanie

    Konferencja soap! to święto każdego Tech Writera. Razem z Edytą Rakowską, technoskrybką z Wrocławia, omawiamy nasze ulubione warsztaty i wystąpienia z edycji 2022. 

    Rozmawiamy o sztucznej inteligencji, planowaniu ContentOps, umiejętnościach, które pozwolą nam przetrwać czwartą rewolucję przemysłową i narzędziach. Łączymy ze sobą niepowiązane tematy, odkrywamy nowe dziedziny do zbadania i nie stronimy od rożnej jakości żartów. 

    Dźwięki wykorzystane w audycji 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 (https://creativecommons.org/licenses/by/4.0/).

    Informacje dodatkowe:


    Konferencja soap!: https://soapconf.com/
    "Event-driven vs REST API interactions": https://blog.axway.com/amplify-products/api-management/event-driven-vs-rest-api-interactions
    AsyncAPI: https://www.asyncapi.com/
    Application programming interface (API): https://pl.wikipedia.org/wiki/Interfejs_programowania_aplikacji
    OpenAI: https://openai.com/
    "#32 Tech Writer zatrudnia asystenta, czyli sztuczna inteligencja w służbie dokumentacji", Tech Writer koduje: https://techwriterkoduje.pl/blog/2021/07/29/tech-writer-zatrudnia-asystenta
    DALL-E 2: https://openai.com/dall-e-2/
    OBS (Open Broadcaster Software): https://obsproject.com/
    Restream: https://restream.io/
    "What Is ContentOps?": https://heretto.com/what-is-contentops/
    "These are the top 10 job skills of tomorrow – and how long it takes to learn them": https://www.weforum.org/agenda/2020/10/top-10-work-skills-of-tomorrow-how-long-it-takes-to-learn-them/

    • 43 min
    #41 Tech Writer rozważa podobieństwa i różnice między kodowaniem a pisaniem dokumentacji

    #41 Tech Writer rozważa podobieństwa i różnice między kodowaniem a pisaniem dokumentacji

    "Docs like code" czy "Docs as code" to model tworzenia dokumentacji, którego głównym założeniem jest traktowanie dokumentacji jak kodu pod kątem procesów oraz narzędzi, których używamy do jej tworzenia. Jednak czy można pójść o krok dalej i rozszerzyć założenia tego modelu na sam proces pisania dokumentacji?

    Rozmawiamy o tym czy pisanie dokumentacji i kodowanie są do siebie podobne, czy kodujący Tech Writer ma jakieś dodatkowe umiejętności, dzięki którym jest w stanie dostarczać dokumentację lepszej jakości i czy dokumentacja mogłaby czerpać korzyści z testów, które są tworzone dla oprogramowania.

    Dźwięki wykorzystane w audycji 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 (https://creativecommons.org/licenses/by/4.0/).

    Informacje dodatkowe:


    "Docs like code", Anne Gentle:  https://www.docslikecode.com/book/
    "Docs as code", Write the Docs:  https://www.writethedocs.org/guide/docs-as-code/
    "#39 DITA as code, czyli klasyczny standard w nowoczesnym wydaniu", Tech Writer koduje: https://techwriterkoduje.pl/blog/2022/02/14/dita-as-code
    Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
    Oxygen XML: https://www.oxygenxml.com/#bidx-xml-author
    IntelliJ IDEA: https://www.jetbrains.com/idea/
    Microsoft Word: https://www.microsoft.com/pl-pl/microsoft-365/word
    "Programowanie imperatywne oraz deklaratywne", Codenga: https://codenga.pl/artykuly/poradniki/programowanie-imperatywne-oraz-deklaratywne
    React: https://pl.reactjs.org/
    Programowanie obiektowe: https://pl.wikipedia.org/wiki/Programowanie_obiektowe
    Docusaurus: https://docusaurus.io/
    Behavior-driven development (BDD): https://pl.wikipedia.org/wiki/Behavior-driven_development
    Cucumber: https://cucumber.io/
    "Rodzaje testów oprogramowania", Testerzy.pl: https://testerzy.pl/baza-wiedzy/artykuly/rodzaje-testow-oprogramowania
    Test-driven development (TDD): https://pl.wikipedia.org/wiki/Test-driven_development
    Foobar: https://pl.wikipedia.org/wiki/Foobar
    Nuxt: https://nuxtjs.org/

    • 37 min