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

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/

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

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/

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/

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/

"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

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