
Sign up to save your podcasts
Or


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:
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:
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:
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:
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:
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:
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:
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:
"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:
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:
From the publisher's feed