Tech Writer Koduje

Michał Skowron i Paweł Kowaluk

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.

  1. #81 Tech Writer VS Coduje, czyli pisanie dokumentacji w modelu docs as code

    -5 J

    #81 Tech Writer VS Coduje, czyli pisanie dokumentacji w modelu docs as code

    Zapewne każdy programista zna albo przynajmniej słyszał o Visual Studio Code (VS Code), czyli darmowym edytorze ze stajni Microsoftu. Jednak podejrzewamy, że nie każdy Tech Writer wie co to za narzędzie i że można go z powodzeniem używać do tworzenia dokumentacji. Raczej nie przyda nam się jeśli pracujemy z narzędziami typu CCMS, ale za to doskonale sprawdzi się w modelu "docs as code", w którym niepodzielnie od wielu lat króluje Markdown. Mnogość opcji konfiguracyjnych i dostępnych wtyczek sprawia, że ten edytor może okazać się świetnym wyborem dla technoskrybów, którzy ściśle współpracują z programistami. Rozmawiamy o tym co nam oferuje VS Code, jakie wtyczki przydają się do pisania dokumentacji, jakie ciekawe funkcje można znaleźć w tym edytorze, a nawet o tym jak dodać podstawowe wsparcie dla plików DITA. 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/). Linki: Visual Studio Code (VS Code): https://code.visualstudio.com/https://code.visualstudio.com/Wtyczka MDX: https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdxWtyczka Markdown All in One: https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-oneWtyczka markdownlint: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlintWtyczka Markdown Preview Enhanced: https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhancedVale: https://github.com/errata-ai/valeWtyczka Vale VSCode: https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscodeWtyczka Write Good Linter: https://marketplace.visualstudio.com/items?itemName=travisthetechie.write-good-linterWtyczka vscode-textlint: https://marketplace.visualstudio.com/items?itemName=taichi.vscode-textlintWtyczka Prettier - Code formatter: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscodeWtyczka Code Spell Checker: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checkerWtyczka Markdown PDF: https://marketplace.visualstudio.com/items?itemName=yzane.markdown-pdfWtyczka Gremlins tracker for Visual Studio Code: https://marketplace.visualstudio.com/items?itemName=nhoizey.gremlinsWtyczka REST Client: https://marketplace.visualstudio.com/items?itemName=humao.rest-clientWtyczka GitLens — Git supercharged: https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens"Lint, Lint and Away! Linters for the English Language", Chris Chinchilla: https://hackernoon.com/lint-lint-and-away-linters-for-the-english-language-70f4b22cc73c"The 2025 Developer Survey", Stack Overflow: https://survey.stackoverflow.co/2025"Darwin Information Typing Architecture" (DITA), Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture"How can I make DITA catalog.xml work in VS Code?", Stack Overflow: https://stackoverflow.com/questions/64782816/how-can-i-make-dita-catalog-xml-work-in-vs-code

    39 min
  2. #80 Tech Writer sprzedaje wartość swojej pracy, czyli jak wytłumaczyć szefostwu technikalia

    28 JUIL.

    #80 Tech Writer sprzedaje wartość swojej pracy, czyli jak wytłumaczyć szefostwu technikalia

    Cały rok pracujesz w pocie czoła w przekonaniu, że Twoja praca ma sens i generuje wartość dla firmy. Zapewne masz rację, ale nie oznacza to, że osoby usytuowane wyżej w hierarchii są tego świadome i rozumieją złożoność tego z czym musisz się mierzyć na co dzień. Dlatego szefostwo organizuje wszelkiej maści spotkania i prezentacje, szczególnie na koniec roku fiskalnego, które są dla Ciebie niepowtarzalną szansą na przedstawienie swojego bogatego dorobku. Rozmawiamy o tym jak pokazać przełożonym wartość swojej pracy, tak żeby po 5 minutach nie stracili zainteresowania, na ile głęboko powinniśmy wchodzić w szczegóły techniczne i jakie cyferki mają znaczenie. W pierwszej części omawiamy wspomniane zagadnienia z punktu widzenia Doc Tools Developera, a w drugiej z punktu widzenia Tech Writera. 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/).

    43 min
  3. #79 Tech Writer koduje z AI, czyli latanie z drugim pilotem w praktyce

    23 JUIN

    #79 Tech Writer koduje z AI, czyli latanie z drugim pilotem w praktyce

    Od niedawna mamy możliwość korzystania w pracy z pomocy sztucznej inteligencji, a konkretnie GitHub Copilota. Rozmawiamy o tym jak działa to narzędzie, jakie ma możliwości i w jaki sposób zmienia naszą pracę. Omawiamy konkretne przykłady zastosowania drugiego pilota w kodowaniu i tworzeniu dokumentacji i staramy się ocenić czy w ogólnym rozrachunku jest on dla nas pomocą, utrudnieniem czy zagrożeniem. 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: GitHub Copilot: https://github.com/features/copilot"Agentic AI", Wikipedia: https://en.wikipedia.org/wiki/Agentic_AI"Darwin Information Typing Architecture", Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture"AI Changes Everything", Armin Ronacher: https://lucumr.pocoo.org/2025/6/4/changes/"My AI Skeptic Friends Are All Nuts", Thomas Ptacek: https://fly.io/blog/youre-all-nuts/"Agent AI - kopilot dla tech writera", Paweł Kowaluk: https://techwriter.pl/copilot-dla-tech-writera"#57 Tech Writer zostaje Prompt Engineerem, czyli nowa potencjalna ścieżka kariery dla technoskryby", Tech Writer Koduje: https://techwriterkoduje.pl/blog/2023/8/28/57

    40 min
  4. #78 Tech Writer buduje społeczność, czyli Content Bytes od kuchni

    16 MAI

    #78 Tech Writer buduje społeczność, czyli Content Bytes od kuchni

    Co mają ze sobą wspólnego wędkarze i technoskryby? I nie chodzi o nam o słowo "ryby". To, że mogą stworzyć społeczność, która będzie się spotykać, wymieniać doświadczeniami i wspierać w trudnych momentach. Ale jak sprawić, żeby taka społeczność powstała? Odpowiedź wydaje się prosta - dać ludziom przestrzeń do spotkań, zrobić prezentację i nakarmić. Jednak w rzeczywistości wymaga to zdecydowanie więcej wysiłku. Rozmawiamy z Edytą Rakowską i Basią Czyż z Content Bytes o cieniach i blaskach organizowania meetupów dla specjalistów zajmujących się szeroko pojętą treścią, o tym co je motywuje do działania, dlaczego warto dołączyć jako uczestnik i prelegent oraz o ich planach na przyszłość. 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: Content Bytes: https://contentbytes.pl/CAKE Conf: https://cakeconf.contentbytes.pl/Content Bytes #04 - "Let's talk language": https://contentbytes.pl/events/2025/4Michał Olender, LinkedIn: https://www.linkedin.com/in/michal-olender/Paweł Chłodnicki, LinkedIn: https://www.linkedin.com/in/pawelchlodnicki/Tomasz Prus, LinkedIn: https://www.linkedin.com/in/tomasz-prus-4b09b01a/Slack: https://slack.com/Linear: https://linear.app/

    44 min
  5. #77 Tech Writer ogarnia gita, czyli moc ukryta w znajomości podstaw

    23 AVR.

    #77 Tech Writer ogarnia gita, czyli moc ukryta w znajomości podstaw

    Mówi się, że zanim zaczniemy biegać musimy nauczyć się chodzić. W tej mądrości ludowej kryje się wiele prawdy, którą można zastosować do nauki jakiegokolwiek zagadnienia, np. systemu kontroli wersji Git. Powierzchowna znajomość Gita i jego najpopularniejszych komend może nam zapewnić spokój na całkiem długi czas, ale w pewnym momencie zaczniemy dostrzegać trudności w radzeniu sobie z pewnymi sytuacjami. Niechlujne wpisy w historii zmian na pewno utrudnią nam ustalenie kto, kiedy i dlaczego coś zmienił, a brak znajomości podstawowych zagadnień i mechaniki Gita spowoduje, że nieraz poczujemy się zagubieni i bezradni. Rozmawiamy o tym jak zadbać o to, żeby nasza historia zmian była jasna i przejrzysta, a przez to przydatna i z jakiego zakresu uzupełnić wiedzę teoretyczną o Gicie, a także dzielimy się wskazówkami na temat przydatnych ustawień i komend. 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: Git: https://git-scm.com/"How to Write a Git Commit Message", cbeams: https://cbea.ms/git-commit/"Git turns 20: A Q&A with Linus Torvalds", GitHub: https://github.blog/open-source/git/git-turns-20-a-qa-with-linus-torvalds/"How did Git get its name?", Initial Commit: https://initialcommit.com/blog/How-Did-Git-Get-Its-NameConventional Commits: https://www.conventionalcommits.org/en/v1.0.0/"Darwin Information Typing Architecture (DITA)", Wikipedia: https://pl.wikipedia.org/wiki/Darwin_Information_Typing_Architecture"Git Squash Commits: A Guide With Examples", DataCamp: https://www.datacamp.com/tutorial/git-squash-commits"How to Create and Push an Empty Commit in Git", Tower FAQ: https://www.git-tower.com/learn/git/faq/git-empty-commit"8.1 Customizing Git - Git Configuration", Git: https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration

    50 min
  6. #76 Tech Writer staje się bardziej otwarty, czyli jak i po co wejść w open source

    28 MARS

    #76 Tech Writer staje się bardziej otwarty, czyli jak i po co wejść w open source

    Naszym zdaniem otwarty umysł to bardzo przydatna cecha. Idea otwartości w połączeniu z działaniem na rzecz wspólnego dobra to nic innego jak "open source". Projekty z obszaru wolnego i otwartego oprogramowania przynoszą wielu organizacjom i jednostkom niebagatelne korzyści. Pomimo tego, że większość z nas jest świadoma ich ogromnej wartości, zazwyczaj borykają się one z problemem braku rąk do pracy. Cierpi na tym nie tylko kod, ale też dokumentacja. I to bardzo. Z naszym gościem, Łukaszem Górnickim, staramy się Wam przybliżyć wyjątkowy świat "open source". Rozmawiamy o tym czym jest wolne i otwarte oprogramowanie, jakimi prawami się rządzi i jak wygląda praca w projektach "open source", dlaczego warto do nich dołączyć i jak to zrobić. A to wszystko z perpektywy Tech Writera. 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: "Open-source software", Wikipedia: https://en.wikipedia.org/wiki/Open-source_software"FLOSS and FOSS", Richard Stallman: https://www.gnu.org/philosophy/floss-and-foss.en.htmlOpen Source Initiative (OSI): https://opensource.org/Google Season of Docs: https://developers.google.com/season-of-docsOutreachy: https://www.outreachy.org/Kubernetes: https://kubernetes.io/Postman: https://www.postman.com/AsyncAPI: https://www.asyncapi.com/en"VMware Sued over Alleged Open Source License Violation in Linux", Sean Michael Kerner: https://www.datamation.com/open-source/vmware-sued-over-alleged-open-source-license-violation-in-linux/Git: https://git-scm.com/GitHub (vel "Instagram dla deweloperów"): https://github.com/Techwriter.pl: https://techwriter.pl/Open Source Program Office (OSPO): https://github.com/todogroup/ospodefinition.orgOSPOs for good 2024 conference report: https://www.un.org/digital-emerging-technologies/sites/www.un.org.techenvoy/files/OPSOs_for_Good_2024_Conference_Report.pdf"The European Organization for Nuclear Research (CERN) ": https://en.wikipedia.org/wiki/CERNOpenForum Europe (OFE): https://openforumeurope.org/about-ofe/Capital Series Poland: https://openforumeurope.org/event/capital-series-poland/Bielik LLM: https://bielik.ai/Brain Fart Services: https://www.brainfart.dev/

    1 h 16 min
  7. #75 Tech Writer wprowadza porządek, czyli po co nam structured writing

    3 MARS

    #75 Tech Writer wprowadza porządek, czyli po co nam structured writing

    W komunikacji technicznej (i nie tylko) występuje zjawisko ustrukturyzowanego tworzenia treści, czyli "structured writing" albo jak kto woli "structured authoring". Cała idea sprowadza się do stworzenia zasad, które są potem stosowane w trakcie pisania. Poprzez narzucenie takich ściśle określonych reguł jesteśmy w stanie dostarczać treść, która jest lepszej jakości i którą nasi odbiorcy są w stanie łatwiej i szybciej konsumować. "Structured writing" to złożone zagadnienie. Mnogość zalet przeplata się tutaj z równie dużą liczbą wyzwań. Rozmawiamy o tym czym jest ustrukturyzowane tworzenie treści, co nam daje, w czym nam pomaga a w czym przeszkadza oraz jakich standardów i narzędzi możemy użyć do jego wdrożenia w organizacji. 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: "Structured writing", Wikipedia: https://en.wikipedia.org/wiki/Structured_writing"Structured authoring in technical documentation: an overview", Author-it blog: https://www.author-it.com/blog/structured-authoring-in-technical-documentation/"What is Structured Writing?", Mark Baker: https://techwhirl.com/what-is-structured-writing/"Topic-based authoring", Wikipedia: https://en.wikipedia.org/wiki/Topic-based_authoring"Darwin Information Typing Architecture", Wikipedia (DITA): https://pl.wikipedia.org/wiki/Darwin_Information_Typing_Architecture "Markdown", Wikipedia: https://pl.wikipedia.org/wiki/Markdown"The path to structured content with Markdown", Niklas Begley: https://www.doctave.com/blog/path-to-structured-markdownSemantic Authoring Markdown (sam): https://github.com/mbakeranalecta/samSemantic Markdown: https://hackmd.io/@sparna/semantic-markdown-draft#What-is-Semantic-MarkdownMarkdoc: https://markdoc.dev/MDX: https://mdxjs.com/Lightweight DITA: https://docs.oasis-open.org/dita/LwDITA/v1.0/cnprd01/LwDITA-v1.0-cnprd01.htmlHyperText Markup Language (HTML): https://developer.mozilla.org/en-US/docs/Web/HTML

    56 min
  8. #74 Tech Writer poszukuje clou swojej pracy, czyli za co nam płacą

    29 JANV.

    #74 Tech Writer poszukuje clou swojej pracy, czyli za co nam płacą

    Kiedy Tech Writer nie koduje, zaczyna rozważać nad swoją egzystencją, a dokładniej nad tym jaką unikalną wartość wnosi jego praca. Nie jest łatwo odpowiedzieć na pytanie jakie jest clou pracy Tech Writera, dlatego o pomoc poprosiliśmy Aleksandrę Wieczorek-Konieczko, która ma kilka lat różnorodnego doświadczenia w branży komunikacji technicznej i sporo przemyśleń na ten temat. Wspólnie zastanawiamy się za co nam tak naprawdę płacą i dlaczego naszej pracy nie może wykonywać ktoś inny z równie dobrym skutkiem. 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: Passo uno, Fabrizio Ferri Benedetti: https://passo.uno/ "The Seven-Action Documentation model", Fabrizio Ferri Benedetti: https://passo.uno/seven-action-model/ "Your docs are your infrastructure", The Stack Overflow Podcast: https://stackoverflow.blog/2024/11/26/your-docs-are-your-infrastructure/ "Czy dobra aplikacja potrzebuje instrukcji", Michał Skowron: https://www.slideshare.net/slideshow/czy-dobra-aplikacja-potrzebuje-instrukcji/83832453 Aleksandra Wieczorek-Konieczko, LinkedIn: https://pl.linkedin.com/in/techwriter-wieczorek

    1 h 11 min
Tout afficher (81)

À propos

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.

Informations

  • Création
    Michał Skowron i Paweł Kowaluk
  • Années d’activité
    2019 - 2025
  • Épisodes
    81
  • Classification
    Tous publics
  • Copyright
    © Michał Skowron i Paweł Kowaluk
  • Site web de l’émission
    Tech Writer Koduje