Relacja z krakowskiego MeetContent (30.05.17)

MeetContent 30.05 już za nami! Dzięki wystąpieniu Tomasza Treli mogliśmy usłyszeć sporo o dokumentacji oprogramowania, przyjrzeć się z bliska kilku problemom z życia wziętym, porozmawiać z developerami, wygrać wejściówkę na soap! 2017 i, oczywiście, napić się dobrego piwa.

Tomek rysuje, uczy się koreańskiego i zna język migowy, a na co dzień pracuje jako Technical Writer, trzymając pieczę nad dokumentacją związaną z softwarem. Często jednak zakasuje rękawy i sam bierze się za pisanie kodu.

Wystąpienie miało obalić mit głoszący, że Technical Writer jest na szarym końcu „łańcucha pokarmowego” firmy i tam właśnie musi pozostać. Jego prezentacja była więc płynnym przejściem z ostatniego MeetContent, o którym możecie przeczytać tutaj. W jaki sposób Tomek zabrał się do argumentacji?

Na początek podzielił się własną historią zawodową i oficjalną nazwą swojego stanowiska, brzmiącą „User Assistance Developer”. Interesujący kryptonim na specjalistę od dokumentacji. Przedstawił poszczególne etapy pracy nad projektami w swojej firmie i wyjaśnił, jaką rolę w nich odgrywa.

Zasadniczo, prezentacja przedstawiła trzy bardzo praktyczne scenariusze, w których rola Technical Writera okazała się istotniejsza, niż można było się spodziewać. Pierwszy z nich dotyczył wprowadzania nowej funkcjonalności do programu i związanych z tym trudności z utrzymywaniem właściwej dokumentacji. Drugi scenariusz dotyczył dokumentacji API, która miała za zadanie generować się automatycznie (co nie było takie proste). Trzeci natomiast mówił o instrukcji, której pisanie rozpoczął programista.

Każdy z trzech scenariuszy był odrębny i mówił o problemie innego typu. Tak się jednak złożyło, że rozwiązanie każdego z nich wiązało się z samodzielnym napisaniem kodu (z pomocą zaprzyjaźnionego programisty). Cóż, jak widać, Tomka zdecydowanie ciągnie w stronę programowania.

Siłą rzeczy, pojawiło się pytanie: czy do rozwiązywania problemów z dokumentacją software’ową konieczne są umiejętności programisty? „Konieczne” być może nie jest najlepszym określeniem, ale „przydatne” już tak.

Nie wydaje nam się jednak, że to jedyny wniosek, jaki można było wyciągnąć ze spotkania. W rozwiązaniu każdego z wymienionych problemów kluczową rolę odegrała bowiem komunikacja. Pytania zadawane przez developerów, rozwiązania podsuwane przez Technical Writerów, współpraca między zespołami – ciężko je przecenić.

Na uwagę zasługują autorskie rysunki Tomka wykorzystane w prezentacji – ciekawe, dosadne, ładnie zrobione. Tomek zaprasza na @thedocshit, (profil na Twitterze dla Technical Writerów, o którym już niegdyś pisaliśmy) i poleca swój adres na GitHubie, gdzie znajdziecie jego rysunki, a także prezentację z jego wystąpienia na MeetContent.

Pytania zadawane po wystąpieniu przerodziły się w aktywną dyskusję, m.in. na temat automatyzacji w dokumentacji technicznej. Czy Tech Writerzy wynajdujący bardziej efektywne sposoby tworzenia treści sami podcinają gałąź, na której siedzą? A może z czasem staną się programistami?

Jedno jest pewne: istnieją nie tylko Tech Writerzy zainteresowani programowaniem, ale również developerzy zainteresowani tworzeniem dokumentacji. Można było ich spotkać na ostatnim wydarzeniu MeetContent w Artefakt Cafe. Liczymy na następne!