Zapraszamy na skrót z ostatnich odcinków podcastu Tech Writer Koduje. W odcinku 41 posłuchacie rozważań na temat podobieństw i różnic między kodowaniem a pisaniem dokumentacji. Odcinek 42 to podsumowanie tegorocznej konferencji soap!
Odcinek 41
W tym podcaście Michał i Paweł rozmawiają o tym czy pisanie dokumentacji i kodowanie są do siebie podobne. Zastanawiają się też czy kodujący technical writer ma jakieś dodatkowe umiejętności, dzięki którym jest w stanie dostarczać dokumentację lepszej jakości. Próbują też odpowiedzieć na pytanie: czy dokumentacja mogłaby czerpać korzyści z testów, które są tworzone dla oprogramowania.
W tym odcinku podstawę ich rozmowy stanowi model tworzenia dokumentacji zwany "Docs like code" czy "Docs as code". Jego głównym założeniem jest traktowanie dokumentacji jak kodu pod kątem procesów oraz narzędzi, które używane są do jej tworzenia. Jednak czy można pójść o krok dalej i rozszerzyć założenia tego modelu na sam proces pisania dokumentacji? O tym w odcinku #41 Tech Writer rozważa podobieństwa i różnice między kodowaniem a pisaniem dokumentacji.
Na samym początku rozmowy Michał wraz z Pawłem poruszają, w bardzo ciekawy i obrazowy sposób, temat procesu tworzenia dokumentacji z procesem pisania kodu. Poznacie “przykład z życia” przytoczony przez Michała, elementy warsztatu pisarskiego Stephena Kinga, a także wzmiankę Pawła o tym jakie znaczenie w procesie twórczym może mieć młotek i gwoździe.
W rozmowie dotyczącej podobieństw oraz różnic w pisaniu dokumentacji i kodu Paweł, na przykładzie prostych przepisów kulinarnych, przedstawił dwa podejścia do programowania - deklaratywne oraz imperatywne. Przedstawienie tego tematu w taki sposób pozwala zrozumieć skomplikowane mechanizmy programistyczne osobom nie mającym z nimi styczności. Rozszerzając ten temat, Paweł wytłumaczył także podobne zależności funkcjonujące w pracy technical writera.
Posłuchacie też sporo na temat DITA, Markdowna, Oxygenu, IntelliJ IDEA, Reacta, a także Microsoft Word. Panowie dyskutują jak te wszystkie narzędzia pomagają, a czasem sprawiają trudności w pracy technical writera oraz jaki mają wpływ na to, jak wygląda proces tworzenia dokumentacji.
Jedną z ostatnich kwestii poruszonych przez rozmówców jest porównanie pisania dokumentacji z pisaniem testów do programowania. O dziwo, obydwa zagadnienia mają sporo wspólnego - zarówno pod kątem tworzenia dokumentacji/kodu, ale też patrząc na proces pracy, jaką wykonuje technical writer/tester.
A co z jakością dokumentacji tworzonej przez osobę z doświadczeniem programistycznym? Czy jest ona lepsza, niż ta, którą dostarcza technical writer bez doświadczenia w tej materii? Wiedza programistyczna jest zdecydowanie pomocna w tworzeniu dokumentacji dla deweloperów. Trudno jednak stwierdzić, czy taka wiedza jest pomocą w tworzeniu dokumentacji dla użytkownika, gdyż jest ona pisana do różnych aplikacji czy urządzeń, niekoniecznie mających związek z wiedzą programistyczną. Natomiast zdecydowanie pomocne jest to, gdy technical writer, może być jednocześnie użytkownikiem czy testerem tego, co jest przedmiotem dokumentacji.
Jeśli temat dokumentacji i kodowania jest Wam bliski, zachęcam do odsłuchania tego odcinka podcastu Tech Writer Koduje. Wbrew pozorom, dziedziny te mają ze sobą bardzo wiele wspólnego.
Odcinek 42
Jak słusznie zauważają prowadzący podcast, konferencja soap! to święto każdego technical writera. Dlatego też nie mogło się u nich obyć bez podsumowania i omówienia ulubionych warsztatów i wystąpień z edycji 2022. W rozmowie Michałowi i Pawłowi towarzyszy Edyta Rakowska, tech writerka z Wrocławia.
Warsztaty
Michał ciekawie opisuje trzy warsztaty, w których wziął udział w dniu poprzedzającym główny blok konferencji. Pierwszy z nich dotyczył dokumentacji API opartych na zdarzeniach. Tematem drugiego było wykorzystanie sztucznej inteligencji w tworzeniu dokumentacji. Ostatni z warsztatów dotyczył aplikacji Open Broadcaster Software. Wywiązała się tu dość ciekawa dyskusja jak wykorzystać te różnorodne pomysły w codziennym życiu technical writera. Rozmówcom szczególnie spodobał się temat wykorzystania AI. Muszę przyznać, że niektóre pomysły chłopaków były interesujące. Edyta natomiast zwróciła uwagę na dość często pojawiający się temat zastępowania tekstu materiałami video.
Prelekcje
Drugą część podcastu stanowi omówienie kilku prelekcji z kolejnych dni konferencji. Jest to subiektywna ocena tego, co się działo, z wyróżnieniem kilku tematów, które zapadły rozmówcom szczególnie w pamięci.
Paweł, z racji zainteresowań, wziął udział w prezentacji dotyczącej Content Ops. Jak się okazało, Michał i Edyta także wzięli w niej udział i cała trójka była z niej bardzo zadowolona. Edyta dodała od siebie prezentację otwierającą konferencję, która dotyczyła fake newsów, tego jak wykorzystywane są informacje i jak dokumentacja musi być dostosowywana do problemów związanych z tym, że użytkownicy coraz częściej nie sprawdzają źródeł. Michał wrócił do tematu sztucznej inteligencji i szybkością, z jaką obecnie rozwijają się technologie i jak, my ludzie powinniśmy dostosowywać się do postępujących zmian.
Jeśli jesteście ciekawi co jeszcze działo się na soap! 2022 koniecznie odsłuchajcie ten odcinek. Dowiecie się kilku ciekawostek, o których być może nie usłyszycie nigdzie indziej.
A my już teraz zapraszamy Was na naszą relację z soap!, która pojawi się już wkrótce.