Tech Writer Koduje - odcinek 30 i 31

Pora na skrót ostatnich odcinków podcastu Tech Writer Koduje. Tematem odcinka 30 jest feedback. Natomiast z 31 dowiecie się jak stworzyć generator stron statycznych. Zapraszamy!

Odcinek 30

Gościem tego odcinka jest Rafał Pawlicki, IT Documentation Manager, który wraz z prowadzącymi rozmawiał na temat feedbacku do dokumentacji.

Czy wiecie jak najlepiej przetłumaczyć na polski słowo feedback?

Według słownika Google słowo to należy tłumaczyć jako sprzężenie zwrotne. Zdaniem rozmówców, w przypadku dokumentacji, tłumaczenie to nie jest zbyt trafione. Dlaczego? Brzmi dość dziwnie i nie oddaje tego, czym w rzeczywistości jest feedback dla technical writera.

Czym zatem jest feedback?

Zdaniem Rafała to zestaw informacji z wielu źródeł, które zostają zebrane i przeanalizowane na różne sposoby. Wnioski z analizy pozwolą na decyzję w jakim kierunku ma być rozwijana dalsza praca nad projektem czy produktem. Dodatkowo należy określić cel w jakim zbieramy informacje zwrotne oraz sposób w jaki najlepiej te dane uzyskać. Jest to temat złoży, który zależy od wielu czynników oraz potrzeb osoby, która zbiera feedback. W dalszej części podcastu panowie omawiają szczegółowo liczne przykłady, tak by słuchacz mógł dobrze zrozumieć wielowymiarowość problemu.

W jakim celu zbieramy feedback?

Głównym celem feedbacku, jest według rozmówców, chęć polepszenia jakości dostarczanej dokumentacji. Za jego pomocą można też uzyskać informacje czy nasze dotychczasowe działania były odpowiednie, a użytkownicy np. narzędzia, są zadowoleni.

Co wpływa na feedback?

Zbieranie informacji jest procesem złożonym, na który wpływa wiele czynników. Spośród nich należy wymienić:

• ilość respondentów w odniesieniu do wielkości grupy docelowej,
• sposób, w jaki zbierane są informacje,
• czas, w którym zbieramy feedback,
• określenie grupy docelowej,
• cel, który określa, jaki feedback chcemy uzyskać.

Wszystkie powyższe aspekty zostały szczegółowo przeanalizowane, a w trakcie ich omawiania, pojawia się kilka innych opcji, na które warto zwrócić uwagę podczas zbierania feedbacku.

W dalszej części odcinka rozmówcy analizują różne ryzyka i wyzwania dotyczące form, jakich można użyć do zbierania feedbacku oraz, która z opcji byłaby najlepsza w danej sytuacji.

Jakich narzędzi warto użyć do zbierania feedbacku?

Głównym narzędziem wartym uwagi jest, zdaniem Rafała, Google Analytics. Jednak, jak dalej zauważa, to nie w narzędziu jest klucz do sukcesu, a cel jaki nam przyświeca. To do niego powinno być dostosowane narzędzie. Warto też skorzystać z tego co już mamy, biorąc pod uwagę koszty, jakie towarzyszą całemu procesowi pozyskiwania feedbacku. Ważne też, by nasze działania były spójne i przejrzyste, co pozwoli uniknąć informacyjnego chaosu.

W odniesieniu do narzędzi zawsze należy brać pod uwagę:

• politykę firmy,
• kwestie przetwarzania danych i informacji,
• licencje,
• utrzymanie danego narzędzia w przyszłości.

Proces zbierania feedbacku

Na koniec panowie stworzyli listę najważniejszych punktów, jakie należy przejść w trakcie procesu zbierania feedbacku:

1. Określenie celu.
2. Zapoznanie się z mechanizmem konkretnej formy zbierania informacji, np. jak powinna być skonstruowana ankieta.
3. Wybór narzędzia, z jakiego chcemy i możemy skorzystać.
4. Określenie grupy docelowej i sprawdzenie, czy dane osoby mogą wziąć udział w badaniu.
5. Określenie sposobu dystrybucji.
6. Określenie czasu, w jakim zbieramy feedback.
7. Określenie konkretnych działań, jakich podejmiemy się po zebraniu informacji.

Każdy z powyższych punktów został szczegółowo omówiony, a wyciągnięte z rozmowy wnioski są bardzo interesujące i przydatne w praktyce. Zachęcamy do odsłuchania całego odcinka, szczególnie gdy zajmujecie się zbieraniem feedbacku.

Odcinek 31

Tematem przewodnim tego odcinka jest tworzenie generatora stron statycznych. Choć tego typu narzędzi jest sporo, Michał wraz z Pawłem postanowili zbudować własny. Dlaczego? Generator został stworzony na potrzeby portalu dokumentacyjnego, z którego panowie korzystają codziennie w pracy. Chodziło o ułatwienie sobie procesów oraz lepszą wydajność portalu. Zanim powstał autorski projekt generatora, panowie przetestowali sporą ilość już istniejących narzędzi. Jednak z każdym z nich coś było nie tak. Stąd wziął się pomysł własnego generatora.

Wymagania:

• Landing Page wyświetlające się w konkretnych środowiskach.
• Prostota użytkowania - narzędzie mało skomplikowane, intuicyjne i przyjemne.
• Napisany w Pythonie.
• Zmniejszenie zewnętrznych zależności narzędzia do minimum.

Panowie większość pracy wykonali w jeden dzień, a o jej elementach i efektach możecie posłuchać w dalszej części odcinka. Jak się okazuje, wszystkie stawiane sobie wymagania zostały spełnione, co dowodzi, że technical writerzy mogą na własne potrzeby stworzyć dopasowany pod siebie generator.

Czy warto poświęcić czas na własny projekt generatora stron statycznych? Jeśli jesteście ciekawi wniosków, do jakich doszedł Paweł z Michałem - zapraszamy do odsłuchania odcinka 31 😉.