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:

#48 Tech Writer uczy się frontendu, czyli jak wykorzystać technologie webowe w dokumentacji
2022-11-16 08:08:55

Na pierwszy rzut oka pisanie dokumentacji ma niewiele wspólnego z frontend developmentem. Kiedy jednak spojrzymy na nowoczesną dokumentację do oprogramowania to możemy odnieść wrażenie, że tak naprawdę niewiele różni się ona od zwykłej strony internetowej. Czy to oznacza, że nadszedł czas, żeby zostać Frontend Tech Writerem? Rozmawiamy o tym jakie umiejętności z zakresu technologii webowych mogą się przydać w pracy technoskryby, w jaki sposób je zdobywać i do czego można je wykorzystać w procesie tworzenia dokumentacji. 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: "Co to jest Front-end i kim jest frontend developer?", Software Development Academy: https://sdacademy.pl/frontend-co-to-jest/  HTML: https://pl.wikipedia.org/wiki/HTML CSS: https://pl.wikipedia.org/wiki/Kaskadowe_arkusze_styl%C3%B3w WordPress: https://wordpress.com/ JavaScript: https://pl.wikipedia.org/wiki/JavaScript "#47 Tech Writer zgłębia tajniki dostępności cyfrowej, czyli jak tworzyć dokumentację dla wszystkich", Tech Writer koduje: https://techwriterkoduje.pl/blog/2022/10/13/dostepnosc-cyfrowa "#25 Tech Writer koduje w dokumentacji, czyli Markdown w wersji rozszerzonej", Tech Writer koduje: https://techwriterkoduje.pl/blog/2021/01/21/tech-writer-koduje-w-dokumentacji Markdown: https://daringfireball.net/projects/markdown/syntax MDX: https://mdxjs.com/ "Wprowadzenie do JSX": https://pl.reactjs.org/docs/introducing-jsx.html React: https://pl.reactjs.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/ Docusaurus: https://docusaurus.io/ Jamstack: https://jamstack.org/ EJS: https://ejs.co/ Eleventy (11ty): https://www.11ty.dev/ TypeScript: https://www.typescriptlang.org/ Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture MadCap Flare: https://www.madcapsoftware.com/products/flare/ Git: https://git-scm.com/

Na pierwszy rzut oka pisanie dokumentacji ma niewiele wspólnego z frontend developmentem. Kiedy jednak spojrzymy na nowoczesną dokumentację do oprogramowania to możemy odnieść wrażenie, że tak naprawdę niewiele różni się ona od zwykłej strony internetowej. Czy to oznacza, że nadszedł czas, żeby zostać Frontend Tech Writerem?

Rozmawiamy o tym jakie umiejętności z zakresu technologii webowych mogą się przydać w pracy technoskryby, w jaki sposób je zdobywać i do czego można je wykorzystać w procesie tworzenia dokumentacji.

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:

  • "Co to jest Front-end i kim jest frontend developer?", Software Development Academy: https://sdacademy.pl/frontend-co-to-jest/ 
  • HTML: https://pl.wikipedia.org/wiki/HTML
  • CSS: https://pl.wikipedia.org/wiki/Kaskadowe_arkusze_styl%C3%B3w
  • WordPress: https://wordpress.com/
  • JavaScript: https://pl.wikipedia.org/wiki/JavaScript
  • "#47 Tech Writer zgłębia tajniki dostępności cyfrowej, czyli jak tworzyć dokumentację dla wszystkich", Tech Writer koduje: https://techwriterkoduje.pl/blog/2022/10/13/dostepnosc-cyfrowa
  • "#25 Tech Writer koduje w dokumentacji, czyli Markdown w wersji rozszerzonej", Tech Writer koduje: https://techwriterkoduje.pl/blog/2021/01/21/tech-writer-koduje-w-dokumentacji
  • Markdown: https://daringfireball.net/projects/markdown/syntax
  • MDX: https://mdxjs.com/
  • "Wprowadzenie do JSX": https://pl.reactjs.org/docs/introducing-jsx.html
  • React: https://pl.reactjs.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/
  • Docusaurus: https://docusaurus.io/
  • Jamstack: https://jamstack.org/
  • EJS: https://ejs.co/
  • Eleventy (11ty): https://www.11ty.dev/
  • TypeScript: https://www.typescriptlang.org/
  • Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture
  • MadCap Flare: https://www.madcapsoftware.com/products/flare/
  • Git: https://git-scm.com/

#47 Tech Writer zgłębia tajniki dostępności cyfrowej, czyli jak tworzyć dokumentację dla wszystkich
2022-10-13 05:15:29

W dzisiejszych czasach, stworzenie strony internetowej jest dość łatwe i szybkie. Jednak stworzenie strony internetowej, która spełnia wymogi dostępności cyfrowej to zupełnie inna bajka. Tutaj potrzebna jest już odpowiednia wiedza, umiejętności oraz znajomość przepisów. Dlatego zaprosiliśmy Dawida Górnego, Kacpra Mikockiego i Tomasza Boniora z firmy Accens, żeby opowiedzieli nam o tym czym jest dostępność, jak o nią zadbać, jak ją testować, jakie narzędzia mogą nam pomóc w wykrywaniu potencjalnych problemów i w jaki sposób technokrybowie mogą sprawić, że ich dokumentacja będzie przyjazna dla każdego. 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: Accens: https://accens.io/ Dostępność (projektowanie), Wikipedia: https://pl.wikipedia.org/wiki/Dost%C4%99pno%C5%9B%C4%87_(projektowanie)  "Czym jest dostępność cyfrowa? Na czym polega?", Accens: https://accens.io/blog/pl/dostepnosc-cyfrowa-definicja/ Używalność (informatyka), Wikipedia: https://pl.wikipedia.org/wiki/U%C5%BCyteczno%C5%9B%C4%87_(informatyka) Americans with Disabilities Act of 1990, Wikipedia: https://en.wikipedia.org/wiki/Americans_with_Disabilities_Act_of_1990 Konwencja o prawach osób niepełnosprawnych, Ministerstwo Rodziny i Polityki Społecznej: https://www.gov.pl/web/rodzina/konwencja-o-prawach-osob-niepelnosprawnych Web Content Accessibility Guidelines (WCAG), W3C: https://www.w3.org/TR/WCAG21/ IBM Equal Access Toolkit: https://www.ibm.com/able/toolkit/tools Axe DevTools: https://www.deque.com/axe/devtools/ Material UI: https://mui.com/ TypeScript: https://www.typescriptlang.org/

W dzisiejszych czasach, stworzenie strony internetowej jest dość łatwe i szybkie. Jednak stworzenie strony internetowej, która spełnia wymogi dostępności cyfrowej to zupełnie inna bajka. Tutaj potrzebna jest już odpowiednia wiedza, umiejętności oraz znajomość przepisów.

Dlatego zaprosiliśmy Dawida Górnego, Kacpra Mikockiego i Tomasza Boniora z firmy Accens, żeby opowiedzieli nam o tym czym jest dostępność, jak o nią zadbać, jak ją testować, jakie narzędzia mogą nam pomóc w wykrywaniu potencjalnych problemów i w jaki sposób technokrybowie mogą sprawić, że ich dokumentacja będzie przyjazna dla każdego.

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:

  • Accens: https://accens.io/
  • Dostępność (projektowanie), Wikipedia: https://pl.wikipedia.org/wiki/Dost%C4%99pno%C5%9B%C4%87_(projektowanie) 
  • "Czym jest dostępność cyfrowa? Na czym polega?", Accens: https://accens.io/blog/pl/dostepnosc-cyfrowa-definicja/
  • Używalność (informatyka), Wikipedia: https://pl.wikipedia.org/wiki/U%C5%BCyteczno%C5%9B%C4%87_(informatyka)
  • Americans with Disabilities Act of 1990, Wikipedia: https://en.wikipedia.org/wiki/Americans_with_Disabilities_Act_of_1990
  • Konwencja o prawach osób niepełnosprawnych, Ministerstwo Rodziny i Polityki Społecznej: https://www.gov.pl/web/rodzina/konwencja-o-prawach-osob-niepelnosprawnych
  • Web Content Accessibility Guidelines (WCAG), W3C: https://www.w3.org/TR/WCAG21/
  • IBM Equal Access Toolkit: https://www.ibm.com/able/toolkit/tools
  • Axe DevTools: https://www.deque.com/axe/devtools/
  • Material UI: https://mui.com/
  • TypeScript: https://www.typescriptlang.org/

#46 Zostań hakerem w służbie pokoju, czyli o "Hack for Peace" słów kilka
2022-09-15 06:18:40

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

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

#45 Tech Writer wybiera pomiędzy narzędziami open source a enterprise, czyli jak zbudować tech stack z przyszłością
2022-09-06 08:20:04

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

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

#44 Rekrutacja Tech Writerów w praktyce, czyli prawie wszystko co trzeba wiedzieć o rynku pracy dla technoskrybów w Polsce
2022-08-01 06:57:34

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/

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/

#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

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

Wyszukiwanie

Kategorie