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

Odcinki od najnowszych:

#43 Tech Writer buduje stronę z dokumentacją, czyli prosty przepis jak zacząć od zera
2022-07-16 20:33:07

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

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

#42 Konferencja soap! 2022 - podsumowanie
2022-06-14 14:06:48

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/

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/

#41 Tech Writer rozważa podobieństwa i różnice między kodowaniem a pisaniem dokumentacji
2022-05-02 07:46:47

"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/

"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/

#40 Tech Writer spełnia swoje marzenia, czyli co i jak można zautomatyzować
2022-03-17 11:47:39

Jedni marzą o drogim samochodzie a drudzy o ekskluzywnych wakacjach w ciepłych krajach. A o czym marzą Tech Writerzy? Odpowiedź znaleźliśmy w newsletterze "Write the Docs" z marca 2022. Okazuje się, że technoskrybowie marzą o tym, żeby pewne elementy ich pracy były zautomatyzowane. Jest to temat bliski naszemu sercu, dlatego postanowiliśmy zmierzyć się z listą życzeń z newslettera. Bazując na swoim doświadczeniu oraz zdobytych informacjach, staramy się zaproponować praktyczne rozwiązania, które przybliżą nasze koleżanki i kolegów po fachu do wymarzonej automatyzacji. 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: Newsletter "Write the Docs", marzec 2022: https://www.writethedocs.org/blog/newsletter-march-2022/ TestCafe: https://testcafe.io/ ImageMagick: https://imagemagick.org/index.php "Simplified User Interface: The Beginner’s Guide": https://www.techsmith.com/blog/simplified-user-interface/ Screen Capture API: https://developer.mozilla.org/en-US/docs/Web/API/Screen_Capture_API "Sharing Screens with the New Javascript Screen Capture API": https://fjolt.com/article/javascript-screen-capture-api Biblioteka Pillow: https://pillow.readthedocs.io/en/stable/ Selenium WebDriver: https://www.selenium.dev/documentation/webdriver/ Conventional commits: https://www.conventionalcommits.org Vale: https://github.com/errata-ai/vale "Documentation as code: Part 3: A Linting How To - The Vale Linter in action (Demo)", Tag1: https://www.tag1consulting.com/blog/documentation-code-linting-part3 "Documentation testing", GitLab: https://docs.gitlab.com/14.8/ee/development/documentation/testing.html Alex: https://alexjs.com/ LanguageTool: https://languagetool.org/pl Schematron: https://www.schematron.com/ "Creative writing with GitHub copilot", Chris Ward: https://www.youtube.com/watch?v=V_CmYyvaMqE "Lint, Lint and Away! Linters for the English Language", Chris Ward: https://dzone.com/articles/lint-lint-and-away-linters-for-the-english-languag Code Spell Checker: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker Gremlins Checker: https://marketplace.visualstudio.com/items?itemName=nhoizey.gremlins "Meet Grazie: the ultimate spelling, grammar, and style checker for IntelliJ IDEA", IntelliJ: https://blog.jetbrains.com/idea/2019/11/meet-grazie-the-ultimate-spelling-grammar-and-style-checker-for-intellij-idea/ Pandoc: https://pandoc.org/ "DITA as code - a modern approach to the classic standard", Tech Writer koduje: https://techwriterkoduje.pl/dita-as-code AutoIt: https://www.autoitscript.com/site/ Bitnami: https://github.com/bitnami

Jedni marzą o drogim samochodzie a drudzy o ekskluzywnych wakacjach w ciepłych krajach. A o czym marzą Tech Writerzy?

Odpowiedź znaleźliśmy w newsletterze "Write the Docs" z marca 2022. Okazuje się, że technoskrybowie marzą o tym, żeby pewne elementy ich pracy były zautomatyzowane. Jest to temat bliski naszemu sercu, dlatego postanowiliśmy zmierzyć się z listą życzeń z newslettera. Bazując na swoim doświadczeniu oraz zdobytych informacjach, staramy się zaproponować praktyczne rozwiązania, które przybliżą nasze koleżanki i kolegów po fachu do wymarzonej automatyzacji.

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:

  • Newsletter "Write the Docs", marzec 2022: https://www.writethedocs.org/blog/newsletter-march-2022/
  • TestCafe: https://testcafe.io/
  • ImageMagick: https://imagemagick.org/index.php
  • "Simplified User Interface: The Beginner’s Guide": https://www.techsmith.com/blog/simplified-user-interface/
  • Screen Capture API: https://developer.mozilla.org/en-US/docs/Web/API/Screen_Capture_API
  • "Sharing Screens with the New Javascript Screen Capture API": https://fjolt.com/article/javascript-screen-capture-api
  • Biblioteka Pillow: https://pillow.readthedocs.io/en/stable/
  • Selenium WebDriver: https://www.selenium.dev/documentation/webdriver/
  • Conventional commits: https://www.conventionalcommits.org
  • Vale: https://github.com/errata-ai/vale
  • "Documentation as code: Part 3: A Linting How To - The Vale Linter in action (Demo)", Tag1: https://www.tag1consulting.com/blog/documentation-code-linting-part3
  • "Documentation testing", GitLab: https://docs.gitlab.com/14.8/ee/development/documentation/testing.html
  • Alex: https://alexjs.com/
  • LanguageTool: https://languagetool.org/pl
  • Schematron: https://www.schematron.com/
  • "Creative writing with GitHub copilot", Chris Ward: https://www.youtube.com/watch?v=V_CmYyvaMqE
  • "Lint, Lint and Away! Linters for the English Language", Chris Ward: https://dzone.com/articles/lint-lint-and-away-linters-for-the-english-languag
  • Code Spell Checker: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
  • Gremlins Checker: https://marketplace.visualstudio.com/items?itemName=nhoizey.gremlins
  • "Meet Grazie: the ultimate spelling, grammar, and style checker for IntelliJ IDEA", IntelliJ: https://blog.jetbrains.com/idea/2019/11/meet-grazie-the-ultimate-spelling-grammar-and-style-checker-for-intellij-idea/
  • Pandoc: https://pandoc.org/
  • "DITA as code - a modern approach to the classic standard", Tech Writer koduje: https://techwriterkoduje.pl/dita-as-code
  • AutoIt: https://www.autoitscript.com/site/
  • Bitnami: https://github.com/bitnami

#39 DITA as code, czyli klasyczny standard w nowoczesnym wydaniu
2022-02-14 07:25:23

DITA w modelu "docs as code"? Kto to widział? Czy to się da zrobić i czy to w ogóle ma sens? Po snuciu teorii na ten temat, przyszedł czas na konkretne działania. Rozmawiamy o tym co do tej pory udało nam się zrobić, żeby w naszej organizacji wdrożyć "DITA as code". Mówimy o narzędziach, przykładowym procesie robienia zmian w dokumentacji, napotkanych trudnościach i kolejnych krokach. Jeśli "DITA z gita" jest bliska Waszemu sercu to zapraszamy do odsłuchu. 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: "#16 DITA z Gita", Tech Writer koduje: https://techwriterkoduje.pl/blog/2020/04/22/dita-z-gita "#8 DITA OT - static site generator dla wtajemniczonych", Tech Writer koduje: https://techwriterkoduje.pl/blog/2019/09/28/dita-ot Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture Component Content Management System (CCMS): https://en.m.wikipedia.org/wiki/Component_content_management_system Git: https://git-scm.com/ "Docs as code", Write the Docs: https://www.writethedocs.org/guide/docs-as-code/ Bitbucket: https://bitbucket.org/ Git submodules: https://www.atlassian.com/git/tutorials/git-submodule Bitbucket pull requests: https://www.atlassian.com/git/tutorials/making-a-pull-request Oxygen XML: https://www.oxygenxml.com/#bidx-xml-author "Krytyczna podatność w bibliotece Apache Log4j": https://cert.pl/posts/2021/12/krytyczna-podatnosc-w-bibliotece-apache-log4j/ Sourcetree: https://www.sourcetreeapp.com/ DITA Open Toolkit (DITA OT): https://www.dita-ot.org/ Docker: https://www.docker.com/ Amazon Simple Storage Service (S3): https://aws.amazon.com/s3/ TeamCity: https://www.jetbrains.com/teamcity Schematron: https://www.schematron.com/ "Content Reuse": https://paligo.net/docs/en/content-reuse.html Git hooks: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks "Readability – what is it and how do I improve it?", Paweł Kowaluk (soap! 2018): https://www.youtube.com/watch?v=LzrHrIOHhz8

DITA w modelu "docs as code"? Kto to widział? Czy to się da zrobić i czy to w ogóle ma sens? Po snuciu teorii na ten temat, przyszedł czas na konkretne działania.

Rozmawiamy o tym co do tej pory udało nam się zrobić, żeby w naszej organizacji wdrożyć "DITA as code". Mówimy o narzędziach, przykładowym procesie robienia zmian w dokumentacji, napotkanych trudnościach i kolejnych krokach.

Jeśli "DITA z gita" jest bliska Waszemu sercu to zapraszamy do odsłuchu.

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:

  • "#16 DITA z Gita", Tech Writer koduje: https://techwriterkoduje.pl/blog/2020/04/22/dita-z-gita
  • "#8 DITA OT - static site generator dla wtajemniczonych", Tech Writer koduje: https://techwriterkoduje.pl/blog/2019/09/28/dita-ot
  • Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
  • Component Content Management System (CCMS): https://en.m.wikipedia.org/wiki/Component_content_management_system
  • Git: https://git-scm.com/
  • "Docs as code", Write the Docs: https://www.writethedocs.org/guide/docs-as-code/
  • Bitbucket: https://bitbucket.org/
  • Git submodules: https://www.atlassian.com/git/tutorials/git-submodule
  • Bitbucket pull requests: https://www.atlassian.com/git/tutorials/making-a-pull-request
  • Oxygen XML: https://www.oxygenxml.com/#bidx-xml-author
  • "Krytyczna podatność w bibliotece Apache Log4j": https://cert.pl/posts/2021/12/krytyczna-podatnosc-w-bibliotece-apache-log4j/
  • Sourcetree: https://www.sourcetreeapp.com/
  • DITA Open Toolkit (DITA OT): https://www.dita-ot.org/
  • Docker: https://www.docker.com/
  • Amazon Simple Storage Service (S3): https://aws.amazon.com/s3/
  • TeamCity: https://www.jetbrains.com/teamcity
  • Schematron: https://www.schematron.com/
  • "Content Reuse": https://paligo.net/docs/en/content-reuse.html
  • Git hooks: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
  • "Readability – what is it and how do I improve it?", Paweł Kowaluk (soap! 2018): https://www.youtube.com/watch?v=LzrHrIOHhz8

#38 Tech Writer walczy z hakerami, czyli jak zadbać o bezpieczeństwo dokumentacji
2022-01-10 06:42:10

Stare porzekadło "Tańcz jakby nikt nie patrzył" niestety nie sprawdzi się w kontekście dokumentacji. Tech Writer powinien raczej stosować zasadę "Szyfruj wszystko tak jakby cały świat chciał przeczytać to co masz do ukrycia". Z Mateuszem Olejarką, specjalistą w zakresie bezpieczeństwa aplikacji webowych, rozmawiamy o tym na co powinniśmy zwracać uwagę w procesie tworzenia dokumentacji, żeby była ona bezpieczna. Dowiecie się gdzie czyhają potencjalne zagrożenia i jak sobie z nimi radzić. 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: Amazon S3: https://aws.amazon.com/s3/ "README.md, czyli historia zbyt pomocnego pliku", Techwriter.pl: http://techwriter.pl/readme-md-czyli-historia-zbyt-pomocnego-pliku/ SmartDeblur: http://smartdeblur.net/ Fake Name Generator: https://www.fakenamegenerator.com/ DumpsterDiver: https://github.com/securing/DumpsterDiver MD5: https://pl.wikipedia.org/wiki/MD5 "Security agencies leak sensitive data by failing to sanitize PDF files": https://therecord.media/security-agencies-leak-sensitive-data-by-failing-to-sanitize-pdf-files/ FOCA (Fingerprinting Organizations with Collected Archives): https://github.com/ElevenPaths/FOCA "FBI used Instagram, an Etsy review, and LinkedIn to identify a protestor accused of arson": https://www.theverge.com/2020/6/18/21295301/philadelphia-protester-arson-identified-social-media-etsy-instagram-linkedin "What is typosquatting and how typosquatting attacks are responsible for malicious modules in npm": https://snyk.io/blog/typosquatting-attacks/ Cross Site Scripting (XSS): https://owasp.org/www-community/attacks/xss/ Wayback Machine: https://web.archive.org/ Okta: https://www.okta.com/ Single Page Application (SPA): https://pl.wikipedia.org/wiki/Single_Page_Application JSON Web Token (JWT): https://jwt.io/ Non-disclosure agreement (NDA): https://en.wikipedia.org/wiki/Non-disclosure_agreement Kevin Mitnick: https://en.wikipedia.org/wiki/Kevin_Mitnick Profil Mateusza Olejarki na LinkedIn: https://pl.linkedin.com/in/molejarka

Stare porzekadło "Tańcz jakby nikt nie patrzył" niestety nie sprawdzi się w kontekście dokumentacji. Tech Writer powinien raczej stosować zasadę "Szyfruj wszystko tak jakby cały świat chciał przeczytać to co masz do ukrycia". Z Mateuszem Olejarką, specjalistą w zakresie bezpieczeństwa aplikacji webowych, rozmawiamy o tym na co powinniśmy zwracać uwagę w procesie tworzenia dokumentacji, żeby była ona bezpieczna. Dowiecie się gdzie czyhają potencjalne zagrożenia i jak sobie z nimi radzić.

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:

  • Amazon S3: https://aws.amazon.com/s3/
  • "README.md, czyli historia zbyt pomocnego pliku", Techwriter.pl: http://techwriter.pl/readme-md-czyli-historia-zbyt-pomocnego-pliku/
  • SmartDeblur: http://smartdeblur.net/
  • Fake Name Generator: https://www.fakenamegenerator.com/
  • DumpsterDiver: https://github.com/securing/DumpsterDiver
  • MD5: https://pl.wikipedia.org/wiki/MD5
  • "Security agencies leak sensitive data by failing to sanitize PDF files": https://therecord.media/security-agencies-leak-sensitive-data-by-failing-to-sanitize-pdf-files/
  • FOCA (Fingerprinting Organizations with Collected Archives): https://github.com/ElevenPaths/FOCA
  • "FBI used Instagram, an Etsy review, and LinkedIn to identify a protestor accused of arson": https://www.theverge.com/2020/6/18/21295301/philadelphia-protester-arson-identified-social-media-etsy-instagram-linkedin
  • "What is typosquatting and how typosquatting attacks are responsible for malicious modules in npm": https://snyk.io/blog/typosquatting-attacks/
  • Cross Site Scripting (XSS): https://owasp.org/www-community/attacks/xss/
  • Wayback Machine: https://web.archive.org/
  • Okta: https://www.okta.com/
  • Single Page Application (SPA): https://pl.wikipedia.org/wiki/Single_Page_Application
  • JSON Web Token (JWT): https://jwt.io/
  • Non-disclosure agreement (NDA): https://en.wikipedia.org/wiki/Non-disclosure_agreement
  • Kevin Mitnick: https://en.wikipedia.org/wiki/Kevin_Mitnick
  • Profil Mateusza Olejarki na LinkedIn: https://pl.linkedin.com/in/molejarka

#37 Tech Writer potrzebuje więcej dynamiki, czyli zbyt statyczne strony z dokumentacją
2021-12-06 11:11:40

Dostarczanie statycznych stron z dokumentacją ostatnimi czasy wraca do łask. Prawdopodobnie dlatego, że takie strony są szybkie, bezpieczne i łatwe w serwowaniu. Jednak w niektórych sytuacjach mogą nas też ograniczać i sprawiać, że aktualizowanie ich zawartości staje się czasochłonne i problematyczne. Rozmawiamy o tym kiedy strony stają się zbyt statyczne i jak można temu zaradzić. Muzyka w intro oraz dźwięki 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 . Informacje dodatkowe: Strona statyczna (static site): https://slownik.intensys.pl/definicja/strona-statyczna/   Serwer aplikacji: https://pl.wikipedia.org/wiki/Serwer_aplikacji Aplikacja internetowa/webowa: https://pl.wikipedia.org/wiki/Aplikacja_internetowa DITA Open Toolkit: https://www.dita-ot.org/ Docusaurus: https://docusaurus.io/ Hugo: https://gohugo.io/ Gatsby: https://www.gatsbyjs.com/ Continuous Integration (CI)/Continuous Deployment (CD): https://en.wikipedia.org/wiki/CI/CD "Git Branch": https://www.atlassian.com/git/tutorials/using-branches Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture Markdown: https://daringfireball.net/projects/markdown/syntax Adobe FrameMaker: https://en.wikipedia.org/wiki/Adobe_FrameMaker Oxygen XML Webhelp Responsive: https://www.oxygenxml.com/doc/versions/24.0/ug-webhelp-responsive/ Next.js: https://nextjs.org/ Node.js: https://nodejs.org/en/ Express.js: https://expressjs.com/ WordPress: https://wordpress.com/

Dostarczanie statycznych stron z dokumentacją ostatnimi czasy wraca do łask. Prawdopodobnie dlatego, że takie strony są szybkie, bezpieczne i łatwe w serwowaniu. Jednak w niektórych sytuacjach mogą nas też ograniczać i sprawiać, że aktualizowanie ich zawartości staje się czasochłonne i problematyczne. Rozmawiamy o tym kiedy strony stają się zbyt statyczne i jak można temu zaradzić.

Muzyka w intro oraz dźwięki 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.

Informacje dodatkowe:

Strona statyczna (static site): https://slownik.intensys.pl/definicja/strona-statyczna/ 

Serwer aplikacji: https://pl.wikipedia.org/wiki/Serwer_aplikacji

Aplikacja internetowa/webowa: https://pl.wikipedia.org/wiki/Aplikacja_internetowa

DITA Open Toolkit: https://www.dita-ot.org/

Docusaurus: https://docusaurus.io/

Hugo: https://gohugo.io/

Gatsby: https://www.gatsbyjs.com/

Continuous Integration (CI)/Continuous Deployment (CD): https://en.wikipedia.org/wiki/CI/CD

"Git Branch": https://www.atlassian.com/git/tutorials/using-branches

Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture

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

Adobe FrameMaker: https://en.wikipedia.org/wiki/Adobe_FrameMaker

Oxygen XML Webhelp Responsive: https://www.oxygenxml.com/doc/versions/24.0/ug-webhelp-responsive/

Next.js: https://nextjs.org/

Node.js: https://nodejs.org/en/

Express.js: https://expressjs.com/

WordPress: https://wordpress.com/

#36 Tech Writer się boi, czyli Halloween Special 2021
2021-10-31 08:15:52

Wszyscy czegoś się boją. Zdarza się, że nawiedzają nas koszmary i zjawy z przeszłości. Tech Writerzy nie są pod tym względem wyjątkiem. Mają swoje, nierzadko osobliwe, strachy. Z okazji Halloween rozmawiamy o tym czego boi się technoskryba i co nie daje mu spać po nocach.  Uwaga: odcinek tylko dla ludzi o mocnych nerwach! Informacje dodatkowe: Grupa "Tworzenie dokumentacji" na Facebooku: https://www.facebook.com/groups/tworzeniedokumentacji Microsoft Word: https://www.microsoft.com/pl-pl/microsoft-365/word "Clippy": https://en.wikipedia.org/wiki/Office_Assistant Subversion (SVN): https://subversion.apache.org/ Git: https://git-scm.com/ "Using Branches": https://svnbook.red-bean.com/en/1.7/svn.branchmerge.using.html Gif "Git merge": https://gifer.com/en/7h7L Git Cherry Pick: https://www.atlassian.com/git/tutorials/cherry-pick Sphinx: https://www.sphinx-doc.org/en/master/ Jamstack: https://jamstack.org/ Python: https://www.python.org/ "What is a Static Site Generator? And 3 ways to find the best one": https://www.netlify.com/blog/2020/04/14/what-is-a-static-site-generator-and-3-ways-to-find-the-best-one/ "Simplified User Interface: The Beginner’s Guide": https://www.techsmith.com/blog/simplified-user-interface/ "Rethink your screenshots and tutorials with a SUI", Anton Bollen: https://www.youtube.com/watch?v=hbT5U63uKkg Micromanagement: https://en.wikipedia.org/wiki/Micromanagement Film "Kingsajz": https://pl.wikipedia.org/wiki/Kingsajz "Writing is like sorting laundry -- practical advice for tackling documentation projects": https://idratherbewriting.com/2015/01/29/writing-is-like-sorting-laundry-practical-advice-for-tackling-documentation-projects/ Podręcznik stylu (style guide): http://techwriter.pl/podrecznik-stylu-stylrecznik/ TeamCity: https://www.jetbrains.com/teamcity/ Docker: https://www.docker.com/ bash: https://pl.wikipedia.org/wiki/Bash Syndrom oszusta: https://pl.wikipedia.org/wiki/Syndrom_oszusta OpenID Connect: https://openid.net/connect/ OAuth 2.0: https://oauth.net/2/ JWT (JSON Web Tokens): https://jwt.io/ Serial comma/Oxford comma: https://en.wikipedia.org/wiki/Serial_comma Stack Overflow: https://stackoverflow.com/ "The One Where Ross Got High", Friends: https://en.wikipedia.org/wiki/The_One_Where_Ross_Got_High

Wszyscy czegoś się boją. Zdarza się, że nawiedzają nas koszmary i zjawy z przeszłości. Tech Writerzy nie są pod tym względem wyjątkiem. Mają swoje, nierzadko osobliwe, strachy. Z okazji Halloween rozmawiamy o tym czego boi się technoskryba i co nie daje mu spać po nocach. 

Uwaga: odcinek tylko dla ludzi o mocnych nerwach!

Informacje dodatkowe:

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

Microsoft Word: https://www.microsoft.com/pl-pl/microsoft-365/word

"Clippy": https://en.wikipedia.org/wiki/Office_Assistant

Subversion (SVN): https://subversion.apache.org/

Git: https://git-scm.com/

"Using Branches": https://svnbook.red-bean.com/en/1.7/svn.branchmerge.using.html

Gif "Git merge": https://gifer.com/en/7h7L

Git Cherry Pick: https://www.atlassian.com/git/tutorials/cherry-pick

Sphinx: https://www.sphinx-doc.org/en/master/

Jamstack: https://jamstack.org/

Python: https://www.python.org/

"What is a Static Site Generator? And 3 ways to find the best one": https://www.netlify.com/blog/2020/04/14/what-is-a-static-site-generator-and-3-ways-to-find-the-best-one/

"Simplified User Interface: The Beginner’s Guide": https://www.techsmith.com/blog/simplified-user-interface/

"Rethink your screenshots and tutorials with a SUI", Anton Bollen: https://www.youtube.com/watch?v=hbT5U63uKkg

Micromanagement: https://en.wikipedia.org/wiki/Micromanagement

Film "Kingsajz": https://pl.wikipedia.org/wiki/Kingsajz

"Writing is like sorting laundry -- practical advice for tackling documentation projects": https://idratherbewriting.com/2015/01/29/writing-is-like-sorting-laundry-practical-advice-for-tackling-documentation-projects/

Podręcznik stylu (style guide): http://techwriter.pl/podrecznik-stylu-stylrecznik/

TeamCity: https://www.jetbrains.com/teamcity/

Docker: https://www.docker.com/

bash: https://pl.wikipedia.org/wiki/Bash

Syndrom oszusta: https://pl.wikipedia.org/wiki/Syndrom_oszusta

OpenID Connect: https://openid.net/connect/

OAuth 2.0: https://oauth.net/2/

JWT (JSON Web Tokens): https://jwt.io/

Serial comma/Oxford comma: https://en.wikipedia.org/wiki/Serial_comma

Stack Overflow: https://stackoverflow.com/

"The One Where Ross Got High", Friends: https://en.wikipedia.org/wiki/The_One_Where_Ross_Got_High

#35 Tech Writer chce kodować więcej
2021-10-26 09:41:43

Czy Tech Writer, który trochę koduje może kodować więcej? Jakie ma opcje rozwoju zawodowego jeśli interesują go głównie skrypty, narzędzia i inne techniczne aspekty tworzenia dokumentacji? Bazując na własnych doświadczeniach, rozważamy trzy możliwe scenariusze dla technoskrybów z zapędami programistycznymi. Pojawia się też kilka czerstwych żartów i nawiązań do zamierzchłych czasów. Muzyka w intro oraz dźwięki 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 . Informacje dodatkowe: Python: https://www.python.org/ MadCap Flare: https://www.madcapsoftware.com/products/flare/ Visual Basic for Applications: Perl: https://www.perl.org/ Arbortext: https://www.ptc.com/en/products/arbortext Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture DITA Open Toolkit: https://www.dita-ot.org/ Front-end i back-end: https://pl.wikipedia.org/wiki/Front-end_i_back-end gulp.js: https://gulpjs.com/ React: https://pl.reactjs.org/ Svelte: https://svelte.dev/ Teleturniej "Idź na całość": https://pl.wikipedia.org/wiki/Id%C5%BA_na_ca%C5%82o%C5%9B%C4%87 Telegazeta: https://pl.wikipedia.org/wiki/Telegazeta

Czy Tech Writer, który trochę koduje może kodować więcej? Jakie ma opcje rozwoju zawodowego jeśli interesują go głównie skrypty, narzędzia i inne techniczne aspekty tworzenia dokumentacji?

Bazując na własnych doświadczeniach, rozważamy trzy możliwe scenariusze dla technoskrybów z zapędami programistycznymi. Pojawia się też kilka czerstwych żartów i nawiązań do zamierzchłych czasów.

Muzyka w intro oraz dźwięki 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.

Informacje dodatkowe:

Python: https://www.python.org/

MadCap Flare: https://www.madcapsoftware.com/products/flare/

Visual Basic for Applications:

Perl: https://www.perl.org/

Arbortext: https://www.ptc.com/en/products/arbortext

Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture

DITA Open Toolkit: https://www.dita-ot.org/

Front-end i back-end: https://pl.wikipedia.org/wiki/Front-end_i_back-end

gulp.js: https://gulpjs.com/

React: https://pl.reactjs.org/

Svelte: https://svelte.dev/

Teleturniej "Idź na całość": https://pl.wikipedia.org/wiki/Id%C5%BA_na_ca%C5%82o%C5%9B%C4%87

Telegazeta: https://pl.wikipedia.org/wiki/Telegazeta

#34 Tech Writer dokumentuje, testuje, koduje, lokalizuje i projektuje, czyli człowiek renesansu w dokumentacji
2021-09-07 19:52:16

Czym na co dzień zajmuje się Technical Writer? A może lepiej zapytać czym się nie zajmuje? Patrycja Pyrek studiuje informatykę i ekonometrię, uczy języka japońskiego i jednocześnie jako stażystka zdobywa techwriterskie doświadczenie. Ta różnorodność zainteresowań przejawia się również podczas jej stażu. Patrycja, poza tworzeniem dokumentacji, ma jeszcze szereg innych zadań, które pozwalają jej się rozwijać w obszarach testowania, lokalizacji i projektowania. Zresztą posłuchajcie sami! Muzyka w intro oraz dźwięki 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 . Informacje dodatkowe: Selenium WebDriver: https://www.selenium.dev/documentation/webdriver/ Protractor: https://www.protractortest.org/ AngularJS: https://angularjs.org/ OpenAPI: https://www.openapis.org/

Czym na co dzień zajmuje się Technical Writer? A może lepiej zapytać czym się nie zajmuje?

Patrycja Pyrek studiuje informatykę i ekonometrię, uczy języka japońskiego i jednocześnie jako stażystka zdobywa techwriterskie doświadczenie. Ta różnorodność zainteresowań przejawia się również podczas jej stażu. Patrycja, poza tworzeniem dokumentacji, ma jeszcze szereg innych zadań, które pozwalają jej się rozwijać w obszarach testowania, lokalizacji i projektowania. Zresztą posłuchajcie sami!

Muzyka w intro oraz dźwięki 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.

Informacje dodatkowe:

Selenium WebDriver: https://www.selenium.dev/documentation/webdriver/

Protractor: https://www.protractortest.org/

AngularJS: https://angularjs.org/

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

Informacja dotycząca prawa autorskich: Wszelka prezentowana tu zawartość podkastu jest własnością jego autora

Wyszukiwanie

Kategorie