Tech Writer Koduje podcast

#Doc Developer #Technologie

46:55

The War and Treaty’s Michael and Tanya Trotter grew up in Cleveland, Ohio, and Washington, DC, respectively, but both have family roots in the South. They also grew up in the musical traditions of their churches – Tanya in the Black Baptist Church and Michael in the Seventh Day Adventist Church – where they learned the power of song to move people. After becoming a father at a very young age, Michael eventually joined the armed forces and served in Iraq and Germany, where he took up songwriting as a way of dealing with his experiences there. Meanwhile Tanya embarked on a singing and acting career after a breakthrough appearance in Sister Act 2 alongside Whoopi Goldberg and Lauryn Hill. Now, after a long and sometimes traumatic journey, Michael and Tanya are married, touring, winning all sorts of awards, and set to release their fifth album together, and their fourth as The War and Treaty. Sid talks to Michael and Tanya about the new record, Plus One , as well as their collaboration with Miranda Lambert, what it was like to record at FAME studios in Muscle Shoals, and how they’re blending country, soul, gospel, and R&B. Learn more about your ad choices. Visit podcastchoices.com/adchoices…

Tech Writer koduje

Μοίρασέ το

Αρχική οθόνη σειράς•Feed

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.

75 επεισόδια

Tech Writer koduje

1,196 subscribers

updated πριν 7 μέρες

Μοίρασέ το

Αρχική οθόνη σειράς•Feed

75 επεισόδια

#Doc Developer #Technologie

Όλα τα επεισόδια

Tech Writer koduje

1
#75 Tech Writer wprowadza porządek, czyli po co nam structured writing 55:30

πριν 7 μέρες55:30

55:30

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-markdown Semantic Authoring Markdown (sam): https://github.com/mbakeranalecta/sam Semantic Markdown: https://hackmd.io/@sparna/semantic-markdown-draft#What-is-Semantic-Markdown Markdoc: https://markdoc.dev/ MDX: https://mdxjs.com/ Lightweight DITA: https://docs.oasis-open.org/dita/LwDITA/v1.0/cnprd01/LwDITA-v1.0-cnprd01.html HyperText Markup Language (HTML): https://developer.mozilla.org/en-US/docs/Web/HTML…

Tech Writer koduje

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

πριν 6 weeks1:10:32

1:10:32

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…

Tech Writer koduje

1
#73 Tech Writer podsumowuje rok 2024, czyli Tech Comm Wrapped 44:36

πριν 11 weeks44:36

44:36

Rok 2024 w komunikacji technicznej i w naszej pracy obfitował w ciekawe wydarzenia i projekty. Na naszych oczach powstawały nowe organizacje i inicjatywy, tworzyły się nowe trendy, a rzeczywistość technologiczna zmusiła nas do eksplorowania różnych rozwiązań. Krótko mówiąc, działo się! Dlatego, podążając za trendem wyznaczonym przez Spotify, postanowiliśmy stworzyć tech commowy Wrapped. Jest to nasze subiektywne podsumowanie najważniejszych rzeczy, które miały miejsce w komunikacji technicznej i w naszym życiu zawodowym w mijającym roku. 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 (LinkedIn): https://www.linkedin.com/company/content-bytes "Content Bytes - nowe oblicze spotkań dla specjalistów od treści", techwriter.pl: https://techwriter.pl/content-bytes-promo/ SAiIT (LinkedIn): https://www.linkedin.com/in/saiit-polska-03a008308/ "Stowarzyszenie Autorów i Ilustratorów Technicznych (SAIiT) - Wywiad z Łukaszem Rybką", techwriter.pl: https://techwriter.pl/saiit-wywiad/ "Stowarzyszenie Autorów i Ilustratorów Technicznych (SAiIT) - Spotkanie założycielskie", techwriter.pl: https://techwriter.pl/saiit-spotkanie-zalozycielskie/ "Stowarzyszenie Autorów i Ilustratorów Technicznych (SAiIT) - Początki działalności", techwriter.pl: https://techwriter.pl/saiit-spotkanie-zalozycielskie-relacja soap! technical communication (LinkedIn): https://www.linkedin.com/company/soap-techcomm "#63 Tech Writer poznaje moc języka w produktach cyfrowych, czyli dlaczego UX writing jest ważny", Tech Writer koduje: https://techwriterkoduje.pl/blog/2024/2/26/63 "UX writing. Moc języka w produktach cyfrowych", Wojciech Aleksander (Onepress): https://onepress.pl/ksiazki/ux-writing-moc-jezyka-w-produktach-cyfrowych-wojciech-aleksander,uxwri.htm "Badanie płac w komunikacji technicznej 2024 – wypełnij ankietę!", techwriter.pl: https://techwriter.pl/badanie-plac-w-komunikacji-technicznej-2024 Artykuły, Tech Writer koduje: https://techwriterkoduje.pl/read MeetContent: https://meetcontent.github.io/ Web Summer Camp: https://websummercamp.com/2025 Passo uno, Fabrizio Ferri Benedetti: https://passo.uno/ "#71 Tech Writer rozlicza się z semantic searcha, czyli plany kontra rzeczywistość", Tech Writer koduje: https://techwriterkoduje.pl/blog/2024/10/28/71 Adrian Wyka (LinkedIn): https://www.linkedin.com/in/adrianwyka/ Accens (LinkedIn): https://www.linkedin.com/company/accens Zbójcerze Dostępności Kupują Prezenty (YouTube): https://www.youtube.com/playlist?list=PLrKAuW72u41T7PpjAshgiwspD9UCILIvU "#16 DITA z Gita", Tech Writer koduje: https://techwriterkoduje.pl/blog/2020/4/22/16…

Tech Writer koduje

1
#72 Tech Writer pyta innych o docs as code, czyli kto i dlaczego porzuca CCMSy 34:59

πριν 15 weeks34:59

34:59

W przeszłości wielokrotnie dzieliliśmy się naszymi przemyśleniami na temat docs as code i CCMSów. Dlatego zamiast po raz kolejny głosić nasze zamiłowanie do rozwiązań niepochodzących od vendorów, postanowiliśmy zapytać innych o ich doświadczenia. Udało nam się znaleźć kilka osób, które uczestniczyły w migracji z CCMSa do docs as code i zgodziły się nam opowiedzieć o tym czy nowe rozwiązanie okazało się lekiem na całe zło czy gorzkim rozczarowaniem. Rozmawiamy o tym dlaczego ludzie porzucają CCMSy, oraz o wyzwaniach, niespełnionych oczekiwaniach i benefitach, czasem nieoczywistych, związanych z przejściem na docs as code. 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: "#65 Tech Writer broni docs as code, czyli klasyczne "u mnie działa"", Tech Writer koduje: https://techwriterkoduje.pl/blog/2024/4/29/65 "Are people abandoning docs as code?", Paweł Kowaluk: https://techwriterkoduje.pl/abandon-docs-as-code " Docs as code is a broken promise", Sarah Moir: https://thisisimportant.net/posts/docs-as-code-broken-promise/ "Docs as Code", Write the Docs: https://www.writethedocs.org/guide/docs-as-code/ "Documentation as Code: why you need it and how to get started", Swimm Team: https://swimm.io/learn/code-documentation/documentation-as-code-why-you-need-it-and-how-to-get-started "Component content management system (CCMS)", Wikipedia: https://en.wikipedia.org/wiki/Component_content_management_system Git: https://git-scm.com/ Markdown: https://daringfireball.net/projects/markdown/ DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture DITA Open Toolkit (DITA OT): https://www.dita-ot.org/…

Tech Writer koduje

1
#71 Tech Writer rozlicza się z semantic searcha, czyli plany kontra rzeczywistość 27:52

πριν 19 weeks27:52

27:52

Prawie rok temu zabraliśmy się za wdrożenie semantic searcha. Byliśmy bardzo podekscytowani tym projektem, bo po długich miesiącach teoretyzowania na ten temat wreszcie udało nam się stworzyć rozwiązanie pilotażowe, które mogliśmy pokazać testowej grupie użytkowników. Zgodnie z obietnicą złożoną w odcinku 61. wracamy do tego projektu. Rozmawiamy o tym jak się potoczyły jego losy, jakie były wyniki testów, jakie wyciągnęliśmy wnioski i co planujemy w przyszłości. 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: "#61 Tech Writer zaczyna wdrażać semantic search, czyli kilka praktycznych wskazówek na początek", Tech Writer koduje: https://techwriterkoduje.pl/blog/2023/12/22/61 "What is semantic search?", Elastic: https://www.elastic.co/what-is/semantic-search "Large language model (LLM)", Wikipedia: https://en.wikipedia.org/wiki/Large_language_model "What Is Retrieval-Augmented Generation, aka RAG?", NVIDIA Blogs: https://blogs.nvidia.com/blog/what-is-retrieval-augmented-generation/ "Hybrid Search Explained", Weaviate: https://weaviate.io/blog/hybrid-search-explained Hugging Face: https://huggingface.co/ "Semantic search", SBERT: https://www.sbert.net/examples/applications/semantic-search/README.html#semantic-search…

Tech Writer koduje

1
#70 Tech Writerka koduje, czyli krótka opowieść o nabywaniu nowych umiejętności 53:45

πριν 23 weeks53:45

53:45

Po prawie 5 latach, ponownie zagościła u nas Agata Rygielska. Tym razem rozmawialiśmy o jej drodze od tłumaczki do kodującej Tech Writerki. Agata opowiedziała nam dlaczego postanowiła rozwijać swoje umiejętności techniczne, jakich języków i technologii się uczyła, w jaki sposób nabywała wiedzę, jakie były dla niej największe wyzwania oraz jakie ma plany na przyszłość. Na koniec dzielimy się wynikami krótkiej ankiety na temat kodowania, którą przeprowadziliśmy wśród Tech Writerów. Dowiecie się z niej m.in. jaki procent ankietowanych koduje a jaki zna rożnicę między Javą i JavaScriptem. 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: "#11 Robot dokumentuje część 2 - automatyzacja kontra ludzie", Tech Writer koduje: https://techwriterkoduje.pl/blog/2019/12/12/11 "Optimus - ofiara chorego systemu, który od lat niszczy polską przedsiębiorczość": https://forsal.pl/artykuly/780660,optimus-ofiara-chorego-systemu-ktory-od-lat-niszczy-polska-przedsiebiorczosc.html MadCap Flare: https://www.madcapsoftware.com/products/flare/ React: https://react.dev/ Docker: https://www.docker.com/ "#27 Tech Writer szkoli się z Pythona", Tech Writer koduje: https://techwriterkoduje.pl/blog/2021/2/17/27 lxml: https://lxml.de/ Jenkins: https://www.jenkins.io/ Babel: https://babeljs.io/ Rollup: https://rollupjs.org/ Git: https://git-scm.com/ Cursor AI: https://www.cursor.com/ Notepad++: https://notepad-plus-plus.org/ Visual Studio Code: https://code.visualstudio.com/ Strona Sebastiana Witowskiego: https://switowski.com/ "Modern Python Projects Course", Talk Python to Me: https://training.talkpython.fm/courses/modern-python-projects PyCharm: https://www.jetbrains.com/pycharm/ Vale: https://github.com/errata-ai/vale Static site generator: https://www.gatsbyjs.com/docs/glossary/static-site-generator/ "What is CodeWhisperer?", Amazon AWS Documentation: https://docs.aws.amazon.com/codewhisperer/latest/userguide/what-is-cwspr.html "Cascading Style Sheets", Wikipedia: https://simple.wikipedia.org/wiki/Cascading_Style_Sheets Sourcery: https://sourcery.ai/ Kotlin: https://kotlinlang.org/ Vasont CMS: https://www.globallinkccms.com/products/vasont "C Sharp (programming language)", Wikipedia: https://en.wikipedia.org/wiki/C_Sharp_(programming_language) "XSL Formatting Objects", Wikipedia: https://pl.wikipedia.org/wiki/XSL_Formatting_Objects Pykonik, Kraków Python User Group: https://www.meetup.com/pl-PL/pykonik/…

Tech Writer koduje

1
#69 Tech Writer uczy się od programistów, czyli co każdy technoskryba powinien wiedzieć o kodowaniu 45:55

πριν 28 weeks45:55

45:55

Pisanie dobrej dokumentacji dla deweloperów oprócz wysoko rozwiniętego warsztatu językowego wymaga również umiejętności technicznych, takich jak kodowanie. Czy teoretyczna znajomość pewnych zagadnień jest wystarczająca czy trzeba również posiadać doświadczenie praktyczne? Rozmawiamy o tym jak bardzo zaawansowane umiejętności techniczne powinien posiadać technoskryba w świecie rozwoju oprogramowania i czego powinien się nauczyć, żeby brylować na deweloperskich salonach i tworzyć dokumentację o wysokiej jakości i wiarygodności. 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: React.js: https://react.dev/ "Git (oprogramowanie)", Wikipedia: https://pl.wikipedia.org/wiki/Git_(oprogramowanie) "Git Amend", W3Schools: https://www.w3schools.com/git/git_amend.asp?remote=github GitHub: https://github.com/ "JavaScript", Wikipedia: https://pl.wikipedia.org/wiki/JavaScript "Java", Wikipedia: https://pl.wikipedia.org/wiki/Java Docker: https://www.docker.com/ Docker Compose overview: https://docs.docker.com/compose/ "Docker image vs container: What are the differences?", CircleCI: https://circleci.com/blog/docker-image-vs-container/ "Why is Python a dynamic language and also a strongly typed language": https://wiki.python.org/moin/Why%20is%20Python%20a%20dynamic%20language%20and%20also%20a%20strongly%20typed%20language Kubernetes: https://kubernetes.io/ "How to Launch an HTTP Server in One Line of Python Code", Real Python: https://realpython.com/python-http-server/ Npm serve: https://www.npmjs.com/package/serve REST Client, VS Code: https://marketplace.visualstudio.com/items?itemName=humao.rest-client HTTP Client, IntelliJ IDEA: https://www.jetbrains.com/help/idea/http-client-in-product-code-editor.html curl: https://curl.se/ Postman: https://www.postman.com/ "bash", Wikipedia: https://pl.wikipedia.org/wiki/Bash…

Tech Writer koduje

1
#68 Tech Writer edukuje programistów, czyli co każdy deweloper powinien wiedzieć o pisaniu dokumentacji 39:14

πριν 32 weeks39:14

39:14

Pisanie dokumentacji jest trudne, co do tego nie mamy wątpliwości. Programiści nie raz w swojej karierze napotykają sytuację, w której muszą opisać jakąś procedurę lub stworzyć README. O ile aktualizacja istniejącej dokumentacji jest do przejścia, to napisanie czegoś od zera może wydawać się zadaniem nie do wykonania. Czy na pewno? Okazuje się, że deweloperzy mogą wiedzieć więcej o pisaniu dokumentacji niż im się wydaje. Wystarczy tylko zmienić sposób myślenia na temat tego procesu i poznać kilka podstawowych zasad tech writingu. W naszej rozmowie łączymy filozoficzne rozważania o podobieństwach pomiędzy kodowaniem i pisaniem dokumentacji z praktycznymi wskazówkami dla programistów na temat pisania 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: Konferencja Web Summer Camp: https://websummercamp.com "Democratizing Design for Better Collaboration", Stephanie Stimac: https://www.youtube.com/watch?v=ZATMLWKIObA&list=PLsL1X_98-_XDD1Lm32Sk8HPyPgZ0e1JeX&index=3 "Guard Clause", DevIQ: https://deviq.com/design-patterns/guard-clause Colima: https://github.com/abiosoft/colima "#67 Tech Writer żegna "foo", "bar" i "baz", czyli jak tworzyć dobre próbki kodu", Tech Writer koduje: https://techwriterkoduje.pl/blog/2024/6/26/67 "Structured writing", Wikipedia: https://en.wikipedia.org/wiki/Structured_writing "Golden rules for writing docs", Tech Writer koduje: https://techwriterkoduje.pl/golden-rules "How did over 300 skeptics start writing docs?", Rafał Pawlicki (soap! 2018): https://www.youtube.com/watch?v=FpcSJa5rEpE "Style guide, czyli księga stylu: jak trzymać fason w UX writingu", UX Writing Wiwisekcja: https://open.spotify.com/episode/4jGjLxt8igNqOCmgb8tOmi?si=33167b19519549bb "Top 10 tips for Microsoft style and voice", Microsoft Writing Style Guide: https://learn.microsoft.com/en-us/style-guide/top-10-tips-style-voice "Software Engineering at Google", Titus Winters, Tom Manshreck, Hyrum Wright: https://www.oreilly.com/library/view/software-engineering-at/9781492082781/…

Tech Writer koduje

1
#67 Tech Writer żegna "foo", "bar" i "baz", czyli jak tworzyć dobre próbki kodu 39:27

πριν 37 weeks39:27

39:27

Próbki kodu to kluczowy element dokumentacji, a w szczególności dokumentacji dla deweloperów. Dlatego uważamy, że "foo", "bar" i "baz" muszą odejść. Jako kodujący Tech Writerzy spotykamy się zarówno z dobrymi jak i kiepskimi przykładami, dlatego postanowiliśmy podsumować naszą wiedzę i doświadczenia w tym zakresie i zastanowić się jak tworzyć próbki, które są pomocne i łatwe do zrozumienia. Rozmawiamy o dobrych i złych praktykach, o potencjalnych problemach i rozwiązaniach oraz, oczywiście, o narzędziach, które możemy wykorzystać, żeby nasze próbki były jeszcze lepsze. 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: "Never Use Foo, Bar, Baz, etc. in Software Documentation", Tech Your Chance: https://www.techyourchance.com/never-use-foo-bar-baz/ "Online resources to learn how to code", StackOverflow Developer Survey 2022: https://survey.stackoverflow.co/2022/#section-learning-to-code-online-resources-to-learn-how-to-code "Online resources to learn how to code", StackOverflow Developer Survey 2023: https://survey.stackoverflow.co/2023/#section-learning-to-code-online-resources-to-learn-how-to-code "Default behaviour sticks (And so do examples)", Thinkst Thoughts: https://blog.thinkst.com/2023/08/default-behaviour-sticks-and-so-do-examples.html "Code blocks", Docusaurus: https://docusaurus.io/docs/markdown-features/code-blocks rundoc: https://eclecticiq.github.io/rundoc/ "Code samples", Google developer documentation style guide: https://developers.google.com/style/code-samples "Creating sample code", Google Technical Writing: https://developers.google.com/tech-writing/two/sample-code "Guidelines for writing code examples", MDN: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Writing_style_guide/Code_style_guide "Write excellent code examples", The Developer Advocacy Handbook: https://developer-advocacy.com/write-excellent-code-examples Dokumentacja React.js: https://react.dev/ Dokumentacja Yarn: https://yarnpkg.com/ Dokumentacja react-router: https://reactrouter.com/en/main Prism.js: https://prismjs.com/ Docusaurus: https://docusaurus.io/ Storybook: https://storybook.js.org/…

Tech Writer koduje

1
#66 Tech Writer nagrywa podcast, czyli kulisy najgorętszej produkcji audio w tech commie 32:09

πριν 41 weeks32:09

32:09

W tym miesiącu nasz podcast obchodzi 5. urodziny. Przez ten czas nagraliśmy ponad 60 odcinków, w których rozmawialiśmy o wielu rzeczach związanych z techniczną stroną tworzenia dokumentacji, ale nigdy o tym co się dzieje za kotarą, o naszych tajnikach i technikach. Dlatego z okazji jubileuszu, postanowiliśmy opowiedzieć Wam dlaczego w ogóle zaczęliśmy nagrywać, skąd czerpiemy pomysły, czy pracujemy ze scenariuszem czy raczej jesteśmy mistrzami improwizacji, jakiego sprzętu i oprogramowania używamy, jak działa nasza strona i czy w ogóle ktoś nas słucha. 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: "#1 Docs like code - rozważania praktyczne i filozoficzne", Tech Writer koduje: https://techwriterkoduje.pl/blog/2019/5/14/1 "Polski podkast dla techwriterów!", Techwriter.pl: https://techwriter.pl/polski-podkast-dla-techwriterow/ Riverside.fm: https://riverside.fm/ Zencastr: https://zencastr.com/ Audacity: https://www.audacityteam.org/ Spotify for Podcasters (dawniej Anchor.fm): https://podcasters.spotify.com/ "RSS", Wikipedia: https://pl.wikipedia.org/wiki/RSS Mikrofon Novox NC-1: https://novox.pl/ "#51 Tech Writer buduje stronę dla podcastu, czyli praktyczne zastosowanie Next.js", Tech Writer koduje: https://techwriterkoduje.pl/blog/2023/2/26/51 "MeetContentKRK zaprasza na Content Day", techwriter.pl: https://techwriter.pl/meet-content-krk-content-day/…

Tech Writer koduje

1
#65 Tech Writer broni docs as code, czyli klasyczne "u mnie działa" 44:30

πριν 45 weeks44:30

44:30

"Docs as code" to filozofia, która głosi, żeby tworzyć dokumentację za pomocą tych samych narzędzi i procesów co oprogramowanie. W zamian za to otrzymujemy szereg benefitów, takich jak lepsza współpraca z programistami, synchronizacja kodu i dokumentacji, wersjonowanie, automatyczne testy oraz ogólne poczucie, że dokumentacja to wspólna odpowiedzialność. Czy takie podejście sprawdza się w praktyce? Czy nie są to tylko puste obietnice, których w rzeczywistości nie da się spełnić? W tym odcinku konfrontujemy artykuł "Docs as code is a broken promise" z naszymi własnymi doświadczeniami i przekonaniami. Uwaga, spoiler! Jako żarliwi zwolennicy docs as code, staramy się pokazać, że pomimo wyzwań jakie ze sobą niesie, jest to podejście, które dobrze się sprawdza w świecie dokumentacji do 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 as code is a broken promise", Sarah Moir: https://thisisimportant.net/posts/docs-as-code-broken-promise/ "Docs as Code", Write the Docs: https://www.writethedocs.org/guide/docs-as-code/ "Documentation as Code: why you need it and how to get started", Swimm Team: https://swimm.io/learn/code-documentation/documentation-as-code-why-you-need-it-and-how-to-get-started Git: https://git-scm.com/ Subversion (SVN): https://subversion.apache.org/ Mercurial: https://www.mercurial-scm.org/ Perforce: https://www.perforce.com/solutions/version-control "What version control systems do you regularly use?", JetBrains: https://www.jetbrains.com/lp/devecosystem-2023/team-tools/#tools_vcs "Component content management system (CCMS)", Wikipedia: https://en.wikipedia.org/wiki/Component_content_management_system GitLab: https://gitlab.com/ GitHub: https://github.com/ The Zen of Python: https://peps.python.org/pep-0020/#the-zen-of-python MadCap Flare: https://www.madcapsoftware.com/products/flare/ Markdown: https://daringfireball.net/projects/markdown/ AsciiDoc: https://asciidoc.org/ Visual Studio Code (VS Code): https://code.visualstudio.com/ Kotlin: https://kotlinlang.org/ IntelliJ IDEA: https://www.jetbrains.com/idea/ "Emancipation: Why the heck would a tech writer use enterprise tools?", Paweł Kowaluk: https://meetcontent.github.io/events/krakow/2024/20 Docusuarus: https://docusaurus.io/ GitLens: https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens…

Tech Writer koduje

1
#64 Tech Writer czepia się DITY, czyli jak tworzyć treść, która się dobrze wyszukuje 34:48

πριν 50 weeks34:48

34:48

Standard DITA, czyli Darwin Information Typing Architecture, nie jest zły sam w sobie, ale może skłaniać nas do stosowania pewnych praktyk, które wpływają negatywnie na wyszukiwanie. Przykładem mogą być strony, które mają bardzo mało treści, przez co nie są zbyt pomocne, a jednocześnie zabierają cenne miejsce na liście wyników wyszukiwania. Kolejną kwestią jest ponownie wykorzystanie treści, czyli reuse. Jest to temat szeroki a problemy z nim związane dotyczą nie tylko standardu DITA. Rozmawiamy o tym co powoduje, że wyniki wyszukiwania nie są pomocne, złych praktykach w tworzeniu dokumentacji w wersji webowej, problemach z reusem i potencjalnych rozwiązaniach. 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: "Darwin Information Typing Architecture", Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture Post Pawła na LinkedIn: https://www.linkedin.com/feed/update/urn:li:activity:7176518908634439680 "Content reuse – a productivity booster or a vicious circle?", JetBrains blog: https://blog.jetbrains.com/writerside/2022/08/content-reuse-a-productivity-booster-or-a-vicious-circle/ "Chunking", OASIS: https://docs.oasis-open.org/dita/v1.2/os/spec/archSpec/chunking.html "Definition of DITA maps", OASIS: https://docs.oasis-open.org/dita/v1.2/os/spec/archSpec/definition-of-ditamaps.html "Every Page is Page One: Topic-based Writing for Technical Communication and the Web", Mark Baker: http://xmlpress.net/publications/eppo/ "Topic-based authoring", Wikipedia: https://en.wikipedia.org/wiki/Topic-based_authoring "Single-source publishing", Wikipedia: https://en.wikipedia.org/wiki/Single-source_publishing…

Tech Writer koduje

1
#63 Tech Writer poznaje moc języka w produktach cyfrowych, czyli dlaczego UX writing jest ważny 1:02:20

πριν 1 year1:02:20

1:02:20

Wyobraź sobie aplikację bez interfejsu. Ciężko się nie zgodzić, że używanie takiego produktu byłoby trudne. Dlatego istnieją specjaliści tacy jak UX Designer. A teraz wyobraź sobie interfejs bez tekstu. Efekt jest właściwie taki jakby tego interfejsu w ogóle nie było. Na co dzień nie zwracamy uwagi na to, że aplikacje komunikują się z nami głównie za pomocą tekstu. Dlatego ważne jest, żeby wszelkie opisy pól, przycisków czy komunikaty były napisane w sposób, który efektywnie prowadzi użytkownika do osiągnięcia celu. I tutaj na białym koniu wjeżdza UX Writer. Pewnie mało kto zdaje sobie sprawę z tego, że teksty w interfejsach to osobna dziedzina, która rządzi się swoimi prawami. Razem z naszym gościem, Wojtkiem Aleksandrem, rozmawiamy m.in. o tym czym jest UX writing, o dobrych praktykach, o tym czego unikać i o wyzwaniach jakie pojawiają się kiedy tworzymy teksty w języku polskim. Ramą dla naszej rozmowy jest wydana niedawno książka Wojtka "UX writing. Moc języka w produktach cyfrowych". 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: "User experience, UX", Wikipedia: https://pl.wikipedia.org/wiki/User_experience "What is plain language?": https://www.plainlanguage.gov/about/definitions/ Konferencja soap!: https://soapconf.com/ "Bad UX Cost Citibank $500M – What Went Wrong?", CMSWire: https://www.cmswire.com/digital-experience/bad-ux-cost-citibank-500m-what-went-wrong/ "Inbox Zero, czyli porządek w skrzynce pocztowej", Codziennie Produktywnie: https://codziennieproduktywnie.pl/inbox-zero/ Grammarly: https://www.grammarly.com/ Wordtune: https://www.wordtune.com/ Frontitude: https://www.frontitude.com/ Hemingway Editor: https://hemingwayapp.com/ Logios Redaktor: https://redaktor.logios.dev/ "UX writing. Moc języka w produktach cyfrowych" (Helion): https://helion.pl/ksiazki/ux-writing-moc-jezyka-w-produktach-cyfrowych-wojciech-aleksander,uxwri.htm#format/d "UX writing. Moc języka w produktach cyfrowych" (Onepress): https://onepress.pl/ksiazki/ux-writing-moc-jezyka-w-produktach-cyfrowych-wojciech-aleksander,uxwri.htm Profil Wojtka Aleksandra na LinkedIn: https://www.linkedin.com/in/waleksander/…

Tech Writer koduje

1
#62 Tech Writer sprawdza co w tech writingu piszczy, czyli rzut oka na ankietę od JetBrains 43:44

πριν 1 year43:44

43:44

Wyniki ankiety JetBrains, "The State of Developer Ecosystem 2023", jakie są, każdy widzi. Mało kto używa dity, wszyscy kodują. Ale skąd takie właśnie wyniki i jaką grupę one odzwierciedlają? Czy Tech Writerzy używają narzędzi enterprise? Czy testują dokumentację? Czy wyłania się nam persona Tech Writera, który koduje? Patrzymy na wyniki ankiety krytycznym okiem, badamy czy mogą one sugerować trendy przyszłości i staramy się ocenić kontekst. Jako bonus bierzemy na warsztat Writerside - narzędzie JetBrains do tworzenia dokumentacji. Omawiamy jego funkcjonalności i fundamentalną zasadę działania. Czy jest to remake MadCap Flare'a? Posłuchaj naszej rozmowy, a dowiesz się co o nim sądzimy. 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: "The State of Developer Ecosystem 2023", JetBrains: https://www.jetbrains.com/lp/devecosystem-2023/ Writerside: https://www.jetbrains.com/writerside/ "Docs as code", Write the Docs: ⁠https://www.writethedocs.org/guide/docs-as-code/ Chris Chinchilla: https://chrischinchilla.com/ MadCap Flare: https://www.madcapsoftware.com/products/flare/ Adobe RoboHelp: https://www.adobe.com/pl/products/robohelp.html ClickHelp: https://clickhelp.com/ Adobe FrameMaker: https://www.adobe.com/pl/products/framemaker.html Help+Manual: https://helpandmanual.com/ WordPress: https://pl.wordpress.org/ Drupal: https://www.drupal.org/ "Markdown", Wikipedia: https://en.wikipedia.org/wiki/Markdown Schematron: https://www.schematron.com/ Swagger UI: https://swagger.io/tools/swagger-ui/ Redoc: https://github.com/Redocly/redoc "Zintegrowane środowisko programistyczne (IDE)", Wikipedia: https://pl.wikipedia.org/wiki/Zintegrowane_%C5%9Brodowisko_programistyczne IntelliJ IDEA: https://www.jetbrains.com/idea/ Wtyczka Writerside: https://plugins.jetbrains.com/plugin/20158-writerside "XML schema", Wikipedia: https://en.wikipedia.org/wiki/XML_schema "Darwin Information Typing Architecture (DITA)", Wikipedia: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture "DocBook", Wikipedia: https://en.wikipedia.org/wiki/DocBook Lightweight DITA: http://docs.oasis-open.org/dita/LwDITA/v1.0/cnprd01/LwDITA-v1.0-cnprd01.html "What is vendor lock-in?", TechTarget: https://www.techtarget.com/searchdatacenter/definition/vendor-lock-in…

Tech Writer koduje

1
#61 Tech Writer zaczyna wdrażać semantic search, czyli kilka praktycznych wskazówek na początek 34:34

πριν 1 year34:34