Doc Developer Podcasty

Kiedy słyszymy Content Management System (CMS) to najpewniej w pierwszym momencie przychodzi nam na myśl WordPress albo Drupal. Raczej mało kto podejrzewa, że System Zarządzania Incydentami (Issue Tracking System) może również w powodzeniem służyć nam do zarządzania treścią. Rozmawiamy o platformie Octotype, która wykorzystuje Next.js do publikowan…

Indeks czytelności (z ang. "readability index") to wskaźnik mówiący nam jak trudny do przeczytania jest dany tekst. Istnieje kilka odmian tego wskaźnika, np. Flesch-Kincaid czy SMOG. Tech Writer, UX Designer i każda inna osoba zajmująca się tworzeniem treści powinna mieć na uwadze indeks czytelności i dbać o to, żeby był on dostosowany do odbiorcy.…

Na pierwszy rzut oka pisanie dokumentacji ma niewiele wspólnego z frontend developmentem. Kiedy jednak spojrzymy na nowoczesną dokumentację do oprogramowania to możemy odnieść wrażenie, że tak naprawdę niewiele różni się ona od zwykłej strony internetowej. Czy to oznacza, że nadszedł czas, żeby zostać Frontend Tech Writerem? Rozmawiamy o tym jakie …

W dzisiejszych czasach, stworzenie strony internetowej jest dość łatwe i szybkie. Jednak stworzenie strony internetowej, która spełnia wymogi dostępności cyfrowej to zupełnie inna bajka. Tutaj potrzebna jest już odpowiednia wiedza, umiejętności oraz znajomość przepisów. Dlatego zaprosiliśmy Dawida Górnego, Kacpra Mikockiego i Tomasza Boniora z firm…

Trzy dni, pięć lokalizacji w różnych częściach Europy i jeden cel - stworzenie produktów technologicznych, które pozwolą na rozwiązanie problemów związanych z wojną. "Hack for Peace" to wydarzenie dla wszystkich, którzy pracują z technologią i chcieliby wykorzystać swoje umiejętności dla wspólnego dobra. Na koniec, jury składające się z przedstawic…

Open source oznacza, że się nie płaci, prawda? Niezupełnie. Nie płaci się pieniędzmi, ale za to płaci się swoim czasem. Trzeba mieć też trochę umiejętności, żeby to ogarnąć. Dlatego może lepiej zapłacić za rozwiązanie enterprise i mieć problem z głowy. Tylko wtedy też musimy zainwestować swój czas w utrzymanie systemu, nie mówiąc już o negocjacjach…

Rekrutacja to temat zawsze na czasie. Również wśród technoskrybów wzbudza on wiele emocji. Dlatego po ponad 2-letniej przerwie wracamy do niego razem z Michałem Słapakiem (Motorola Solutions) i Tomkiem Prusem (Atlassian). Przyglądamy się obecnej sytuacji na rynku pracy dla Tech Writerów w Polsce oraz procesowi rekrutacyjnemu zarówno pod kątem pozio…

Zbudowanie strony z dokumentacją od zera może się wydawać nie lada wyzwaniem. Istnieje mnóstwo sposobów na podejście do tematu. Kiedy myślimy nad potencjalnym rozwiązaniem, do głowy przychodzą nam następujące pytania: Czy można do tego celu użyć darmowych narzędzi? Czy istnieje coś takiego jak bezpłatny hosting? Jak pisać dokumentację bez CCMSa? Ja…

Konferencja soap! to święto każdego Tech Writera. Razem z Edytą Rakowską, technoskrybką z Wrocławia, omawiamy nasze ulubione warsztaty i wystąpienia z edycji 2022. Rozmawiamy o sztucznej inteligencji, planowaniu ContentOps, umiejętnościach, które pozwolą nam przetrwać czwartą rewolucję przemysłową i narzędziach. Łączymy ze sobą niepowiązane tematy,…

"Docs like code" czy "Docs as code" to model tworzenia dokumentacji, którego głównym założeniem jest traktowanie dokumentacji jak kodu pod kątem procesów oraz narzędzi, których używamy do jej tworzenia. Jednak czy można pójść o krok dalej i rozszerzyć założenia tego modelu na sam proces pisania dokumentacji? Rozmawiamy o tym czy pisanie dokumentacj…

Jedni marzą o drogim samochodzie a drudzy o ekskluzywnych wakacjach w ciepłych krajach. A o czym marzą Tech Writerzy? Odpowiedź znaleźliśmy w newsletterze "Write the Docs" z marca 2022. Okazuje się, że technoskrybowie marzą o tym, żeby pewne elementy ich pracy były zautomatyzowane. Jest to temat bliski naszemu sercu, dlatego postanowiliśmy zmierzyć…

DITA w modelu "docs as code"? Kto to widział? Czy to się da zrobić i czy to w ogóle ma sens? Po snuciu teorii na ten temat, przyszedł czas na konkretne działania. Rozmawiamy o tym co do tej pory udało nam się zrobić, żeby w naszej organizacji wdrożyć "DITA as code". Mówimy o narzędziach, przykładowym procesie robienia zmian w dokumentacji, napotkan…

Stare porzekadło "Tańcz jakby nikt nie patrzył" niestety nie sprawdzi się w kontekście dokumentacji. Tech Writer powinien raczej stosować zasadę "Szyfruj wszystko tak jakby cały świat chciał przeczytać to co masz do ukrycia". Z Mateuszem Olejarką, specjalistą w zakresie bezpieczeństwa aplikacji webowych, rozmawiamy o tym na co powinniśmy zwracać uw…

Dostarczanie statycznych stron z dokumentacją ostatnimi czasy wraca do łask. Prawdopodobnie dlatego, że takie strony są szybkie, bezpieczne i łatwe w serwowaniu. Jednak w niektórych sytuacjach mogą nas też ograniczać i sprawiać, że aktualizowanie ich zawartości staje się czasochłonne i problematyczne. Rozmawiamy o tym kiedy strony stają się zbyt st…

Wszyscy czegoś się boją. Zdarza się, że nawiedzają nas koszmary i zjawy z przeszłości. Tech Writerzy nie są pod tym względem wyjątkiem. Mają swoje, nierzadko osobliwe, strachy. Z okazji Halloween rozmawiamy o tym czego boi się technoskryba i co nie daje mu spać po nocach. Uwaga: odcinek tylko dla ludzi o mocnych nerwach! Informacje dodatkowe: Grupa…

Czy Tech Writer, który trochę koduje może kodować więcej? Jakie ma opcje rozwoju zawodowego jeśli interesują go głównie skrypty, narzędzia i inne techniczne aspekty tworzenia dokumentacji? Bazując na własnych doświadczeniach, rozważamy trzy możliwe scenariusze dla technoskrybów z zapędami programistycznymi. Pojawia się też kilka czerstwych żartów i…

Czym na co dzień zajmuje się Technical Writer? A może lepiej zapytać czym się nie zajmuje? Patrycja Pyrek studiuje informatykę i ekonometrię, uczy języka japońskiego i jednocześnie jako stażystka zdobywa techwriterskie doświadczenie. Ta różnorodność zainteresowań przejawia się również podczas jej stażu. Patrycja, poza tworzeniem dokumentacji, ma je…

Czy w kilka miesięcy można nauczyć się kodowania i zostać zatrudnionym jako młodszy programista w międzynarodowej korporacji? Dzięki Akademii Motorola Solutions taki scenariusz jest możliwy. Na początku sierpnia 2021 wystartowała druga edycja tego programu szkoleniowego stworzonego dla osób, które marzą o zmianie kariery i wejściu do świata IT. W t…

Od dawna mówi się o tym, że maszyny zastąpią ludzi i zajmą ich miejsce jako korona stworzenia. Jednak zanim to nastąpi, możemy wykorzystać sztuczną inteligencję do własnych celów. Przyglądamy się obecnie dostępnym modelom językowym, a szczególnie GPT-3, rozmawiamy o tym co potrafią i rozważamy jak można by je wykorzystać w tworzeniu dokumentacji te…

Generatorów stron statycznych jest całkiem sporo. Jednak nie jest to powód, dla którego Tech Writer miałby zrezygnować ze stworzenia swojego. A że technoskryba z natury lubi prostotę i przejrzystość to generator też musi mieć takie cechy. Rozmawiamy o tym dlaczego zdecydowaliśmy się na stworzenie własnego rozwiązania, jakiej technologii użyliśmy, c…

Naszą dokumentację możemy poprawić tylko wtedy jeśli wiemy jakie kryją się w niej problemy. Warto zbierać i analizować dane od użytkowników, a przede wszystkim pytać ich o opinię. Nie jest to bynajmniej proste zadanie, dlatego połączyliśmy siły z Rafałem Pawlickim, żeby porozmawiać o celach, sposobach, wyzwaniach i dobrych praktykach związanych z p…

Pewnego dnia czujesz nieodpartą chęć napisania jakiegoś skryptu. Otwierasz edytor, tworzysz nowy plik i w pocie czoła dodajesz kolejne linijki kodu. Zachowujesz zmiany, wprowadzasz poprawki, weryfikujesz swoje dzieło i powtarzasz cały proces aż po pewnym czasie udaje Ci się doprowadzić skrypt do stanu, w którym robi to co chcesz. Cel osiągnięty. Ni…

Co jest lepsze do pisania kodu - komercyjne środowisko programistyczne czy darmowy edytor kodu źródłowego? Czy takie porównanie w ogóle ma sens? Michał na co dzień pracuje w IntelliJ IDEA, a Paweł, jak spora część programistów, w VS Code. W tej subiektywnej rozmowie na bardzo subiektywny temat nie staramy się rozstrzygnąć, która aplikacja jest leps…

Chcesz lepiej rozumieć kod, który opisujesz? Chcesz zautomatyzować żmudne aspekty swojej pracy? Chcesz móc powiedzieć śmiało i dumnie - znam Pythona? W tym odcinku rozmawiamy z Adrianem Gonciarzem, który prowadzi szkolenia z Pythona dla tech writerów i testerów, oraz Basią Czyż, technical writerką, która wzięła udział w tym szkoleniu. Szkolenie odb…

Pisanie dokumentacji do API to dziedzina sama w sobie, która w dzisiejszych czasach zyskuje na znaczeniu. Przyspieszony rozwój technologii cyfrowych w dobie pandemii i pracy zdalnej podniósł znaczenie dokumentacji w ogóle, a dokumentacji do API w szczególności. Z naszymi gośćmi, Jadwigą Sitnicką z LogMeIn, Mateuszem Wiktorem z PubNub i Pawłem Krent…

Markdown to prosty i lekki język znaczników, który w ostatnich latach zyskał sporą popularność, szczególnie w świecie dokumentacji dla programistów. Pozwala nam on łatwo i szybko stworzyć tekst, a następnie opublikować go jako HTML. Z biegiem czasu pojawiły się różne odmiany i rozszerzenia Markdowna, pozwalające wycisnąć z niego jeszcze więcej. Jed…

Niektóre sposoby publikowania dokumentacji są znane wśród Tech Writerów od zarania dziejów. Portale serwujące wszelakiej maści treści w formacie HTML czy PDF są niejako standardem branżowym. W sytuacji kiedy odbiorcą dokumentacji jest użytkownik produktu te formy spełniają swoje zadanie. Ale co zrobić kiedy do naszej dokumentacji potrzebuje się dob…

Jak zrobić najlepszą dokumentację? Ustalamy wewnętrzne standardy i się ich trzymamy, a potem sprawdzamy czy dokumentacja spełnia swoje cele. Następnie weryfikujemy standardy, żeby nasza dokumentacja spełniała założone cele coraz lepiej. Wydaje się proste, ale diabeł tkwi w szczegółach. Z Rafałem Pawlickim zastanawiamy się jak utrzymywać wewnętrzne …

Next.js to framework Reacta, dzięki któremu można w elastyczny sposób tworzyć nowoczesne strony internetowe. Według rankingu na stronie staticgen.com, jest to również jeden z najpopularniejszych generatorów stron statycznych. Rozmawiamy o tym jak można połączyć Next.js z narzędziem ReDoc, żeby zbudować stronę z dokumentacją dla wielu API stworzonyc…

Web scraping to zbieranie danych ze stron internetowych. Google, na przykład, robi to, żeby indeksować cały internet w swojej wyszukiwarce. Web scraping wykorzystuje się też do monitorowania cen w konkurencyjnych sklepach internetowych. U nas w firmie używamy web scrapingu, żeby indeksować dokumentację dla naszej wyszukiwarki. To samo rozwiązanie w…

Wydajność to temat rzadko poruszany w tech writingu, pomimo tego, że webowa forma dokumentacji jest bardzo popularna. Czy szybkość ładowania stron ma znaczenie dla naszych odbiorców? A jeśli tak, to czy Tech Writer ma jakiś wpływ na wydajność dokumentacji? Rozmawiamy o tym jak mierzyć i poprawiać web performance. Zastanawiamy się co może zrobić w t…

Trwająca od kilku miesięcy sytuacja spowodowała, że biura zostały pozamykane a praca zdalna z dnia na dzień stała się nowym standardem. Jednak istnieją też takie firmy, które już na wczesnym etapie rozwoju podjęły świadomą decyzję, że postawią na model pracy bez tradycyjnych biur. O byciu w pełni zdalnym Technical Writerem rozmawiamy z Marcinem Sęd…

Przejście od zera do kodującego Tech Writera to dość długa droga, i nie zawsze usłana różami. Jednak przy odpowiedniej motywacji i podejściu można podołać temu wyzwaniu. Rozmawiamy o tym jak zacząć naukę kodowania, przez jakie etapy trzeba przejść i jak radzić sobie z problemami i pułapkami. Informacje dodatkowe: Why Learning To Code Is So Damn Har…

Offline help, który sam się aktualizuje. Czy to w ogóle możliwe? Zastanawiamy się czy webhelp czasy świetności ma już za sobą i czy Progressive Web App (PWA) ma szansę zostać nowym królem helpów. Informacje dodatkowe: HTML Help: https://pl.wikipedia.org/wiki/HTML_Help "About Webhelp Output" (pomoc MadCap Flare 2017r3): https://help.madcapsoftware.c…

Czy szanujący się zespół dokumentacyjny używający standardu DITA może działać bez CCMSa? Czy Technical Writer odnajdzie się w gicie? Jakie wyzwania stwarza taka implementacja? Techniczna rozmowa o technical writingu. Informacje dodatkowe: Standard DITA (Darwin Information Typing Architecture): https://en.wikipedia.org/wiki/Darwin_Information_Typing…

Jak Technical Writer radzi sobie ze zdobywaniem informacji? Co jeśli Subject Matter Expert (SME) jest niedostępny? A co jeśli dwóch SME nie może się zgodzić co jest najważniejsze? Rozmawiamy z Mateuszem Boryckim, który przynosi cztery prawdziwe historie (case studies) z życia Technical Writera.

Rozmawiamy z Sebastianem Witowskim o tym jak ustawić sobie środowisko do kodowania w Pythonie i jakich błędów unikać zaczynając swoją przygodę z tym językiem programowania. Spora dawka wiedzy dla początkujących Pythonistów. Ale jeśli kodujesz w Pythonie od jakiegoś czasu i chcesz się upewnić, że stosujesz dobre praktyki, to ten odcinek jest też dla…

Jakie są obowiązki Technical Writera? Pewnie większość z Was odpowiedziałaby, że pisanie dokumentacji. A co z budowaniem stron i hostowaniem ich w chmurze? Damy sobie z tym radę? Ten odcinek to nie rozważania teoretyczne, ale oparta na faktach historia o tym jak trzech Technical Writerów ogarnęło cały stack technologiczny i devops dla portalu z dok…

Czy ogłoszenie o pracę mówi Ci co będziesz robił jako Technical Writer? Jak pracodawca sprawdzi Twoje umiejętności? Co się liczy u Technical Writera? Rozmawiamy z Tomkiem Prusem o blaskach i cieniach rekrutowania Technical Writerów starając się odpowiedzieć na pytanie jak ważne w naszej profesji są umiejętności techniczne.…

Spotkaliśmy się z Agatą Rygielską i rozmawialiśmy o wpływie automatyzacji na ludzi i ich pracę. Agata jest Technical Writerką od 2 lat, a wcześniej pracowała w branży tłumaczeniowej. Widziała jak automatyzacja doprowadziła do marginalizacji "białkowych" tłumaczy. Jej doświadczenia doprowadziły nas do rozważań o przyszłości komunikacji technicznej. …

Docusaurus to static site generator stworzony przez Facebooka, którego główną zaletą jest prostota. Rozmawiamy o tym co oferuje to narzędzie, jakie są jego mocne i słabe strony oraz w jakich sytuacjach może się sprawdzić jako rozwiązanie do tworzenia dokumentacji. Informacje dodatkowe: Docusaurus: https://docusaurus.io/ Using Docusaurus to Create O…

Podobno nikt nie jest niezastąpiony, ale czy można zastąpić całą grupę zawodową? Zwłaszcza ludzi, którzy robią research, rozmawiają z innymi i piszą? O automatyzacji w technical writingu rozmawia z nami Wojtek Aleksander. Informacje dodatkowe: "The Future of Employment: How susceptible are jobs to computerisation?", Oxford Martin: https://www.oxfor…

Jako technoskrybi, którzy kodują, spędziliśmy trochę czasu z DITA Open Toolkit. Rozmawiamy o tym do czego służy DITA OT i jakie ma możliwości. Mówimy o wadach i zaletach. Podpowiadamy też jak zacząć pracę z tym narzędziem. Pracujesz z ditą lub chcesz dowiedzieć się o niej więcej? To jest odcinek dla Ciebie. Informacje dodatkowe: Standard DITA (Darw…

W nowoczesnej firmie software’owej nie ma ani jednego Technical Writera. W takim razie czym się zajmuje nasz gość, Rafał Pawlicki, który pracuje jako Documentation Manager? Dynamiczne zmiany w świecie technologii powodują, że coraz częściej w firmach wytwarzających oprogramowanie granice między tradycyjnie zdefiniowanymi rolami zaczynają się zacier…

EuroPython to największa europejska konferencja poświęcona językowi programowania Python. Tegoroczna edycja odbyła się w dniach 8-14 lipca w Bazylei (Szwajcaria). Przyglądamy się temu wydarzeniu z perspektywy Technical Writera, który od jakiegoś czasu korzysta z Pythona w swojej pracy, ale nie jest zawodowym programistą. Rozmawiamy o tym co się dzi…

Mogłoby się wydawać, że Tech Writerzy nie mają dużych potrzeb jeśli chodzi o narzędzia. W końcu co może być potrzebne do napisania instrukcji? Zapewne wystarczy jakiś prosty edytor i tyle. Nic bardziej mylnego. Technical Writerzy, jak każda profesja, również mają swoje rozwiązania, które pozwalają im tworzyć, dostarczać i łatwiej utrzymywać profesj…

soap! to jedyna polska konferencja dla specjalistów zajmujących się szeroko pojętą treścią. Motywem przewodnim tegorocznej edycji było "Content as code". W tym odcinku, dzielimy się swoimi ogólnymi wrażeniami na temat konferencji oraz rozmawiamy o prezentacjach, które najbardziej zapadły w nam pamięć. Informacje dodatkowe: Konferencja soap!: http:/…

Scalable Vector Graphics (SVG) kryje w sobie wiele ciekawych aspektów, które Technical Writerzy mogliby potencjalnie wykorzystać. Nasz gość, Daniel Barrio Fierro, od jakiegoś czasu nie tylko pasjonuje się tym formatem, ale również wykorzystuje jego zalety pracując nad dokumentacją. W tym odcinku rozmawiamy z Danielem o tym jak Technical Writerzy mo…

Python to język programowania ogólnego zastosowania, który w ostatnich latach zyskuje coraz większą popularność nie tylko wśród programistów. Jednym z powodów jest niewątpliwie jego przystępna składnia przez co osoby, które nie są bardzo techniczne są w stanie dość szybko opanować podstawy kodowania w tym języku. Dlatego też Python wydaje się być d…

"Docs like code" czy "Docs as code" to model tworzenia dokumentacji, który staje się coraz bardziej popularny wśród Tech Writerów w IT. Głównym założeniem jest traktowanie dokumentacji jak kodu pod kątem procesów oraz narzędzi, których używamy do jej tworzenia. Ale czy to wszystko? Staramy się przyjrzeć dokładniej temu trendowi, żeby odkryć co jesz…