TECH WRITER KODUJE – ODCINEK #39 I #40

W najnowszych odcinkach podcastu Tech Writer Koduje znów spotkacie się z bardzo ciekawymi tematami. Co Was czeka? Zapraszamy na nasze podsumowanie.

Odcinek #39

W tym odcinku Michał i Paweł wracają do tematu DITA. Tym razem koncentrują się na modelu “docs as code” i wdrożeniu go do organizacji.

Na samym początku odcinka dowiecie się jaka jest różnica między “DITA z gita”, a “DITA bez gita”. Jeśli to temat, który jest bliski Waszym zainteresowaniom, już teraz przenieście się tutaj i posłuchajcie rozmowy prowadzących.

Po wyjaśnieniu aspektów teoretycznych, Michał zapoznaje słuchaczy z procesami, które wykonuje w swojej codziennej pracy wraz z zespołem współpracowników. Dodatkowo wyjaśnia jakie napotykają trudności i w czym pomaga im nowy sposób pracy z użyciem gita.

Przechodząc do tematu DITA, Michał wraz z Pawłem przypomina czym jest i jak używać static site generator, bazując na własnych doświadczeniach z pracy tech writerskiej.

Z dalszej części materiału dowiecie się jeszcze:

  • Jakich użyć narzędzi?
  • Jak wygląda przykładowy proces zmian w dokumentacji?
  • Jakie można napotkać trudności?
  • Jakie podjąć kroki po wprowadzeniu do organizacji DITA as code?

Odcinek #40

Automatyzacja przynajmniej części procesów to ponoć jedno z marzeń technical writera. Jeśli jest ono także na Waszej liście pragnień to ten odcinek podcastu na pewno Was nie zawiedzie.

Co można zautomatyzować?
Prowadzący wzięli na tapetę kilka rodzajów procesów, które ich zdaniem nadają się do automatyzacji. Są wśród nich:

  • screenshoty i zmiany w tekście UI,
  • lista feature’ów, które są dostępne w danej wersji produktu,
  • release notes,
  • sprawdzanie tekstu pod kątem poprawności gramatycznej, stylistycznej, linków, formatowania itp.,
  • kopiowanie tabeli,
  • buildy i deploymenty,
  • slack boty.

W omówieniu każdego z procesu panowie podają liczne przykłady możliwych zmian, by ułatwić sobie i innym pracę. Niejednokrotnie zastanawiają się czy zamiast próbować automatyzować dane elementy, nie warto najpierw przemyśleć podstawę ich użycia i ewentualną zmianę przedstawienia treści.

Jakich narzędzi używać?
Omawiając możliwe zmiany procesów, prowadzący przytaczają nazwy wielu narzędzi, jakie mogą pomóc w ich automatyzacji. Nie brakuje tu licznych przykładów ich użycia oraz efektów, jakie można uzyskać. W kilku przypadkach praktyka z własnych doświadczeń przechodzi w teoretyzowanie, a pomysły prowadzących mogą być dla Was inspiracją do własnych testów.

W obydwu odcinkach znajdziecie mnóstwo przykładów praktycznych oraz sporą dozę informacji na temat narzędzi używanych przez technical writerów.