Zespół dokumentacyjny w firmie
Zespół zajmujący się dokumentacją, to grupa ludzi, którzy znają się na pisaniu i publikowaniu. Potrafią zrekrutować nowe osoby, bo wiedzą gdzie szukać podobnych sobie. Mogą też utrzymywać swoje wyspecjalizowane narzędzia.
Taki zespół może istnieć w firmie na dwa sposoby: w modelu zintegrowanym lub agencyjnym.
Model zintegrowany
W tym modelu, zespół dokumentacyjny dostarcza specjalistów, którzy dołączają do zespołów projektowych. Wtedy technical writerzy dołączają do innych działów i w nich pracują, a zespół pełni tylko role administracyjne i szkoleniowe.
Dlaczego nie zatrudnić writerów bezpośrednio w zespołach?
- Bo może nie są potrzebni na stałe - wtedy można ich rotować między zespołami
- Bo zespół wytwarzający oprogramowanie zna się na oprogramowaniu i może mu być trudno znaleźć, zatrudnić i wyszkolić technical writera
Wiem, że fajnie jest przeczytać trzy podpunkty, ale mogę znaleźć tylko dwa.
Zaletą tego modelu jest to, że technical writer obcuje z produktem na co dzień, więc gromadzi wiedzę, która inaczej byłaby nieosiągalna. Tego typu model sprawdza się w wypadku skomplikowanych produktów.
Model agencyjny
W tym modelu, zespół dokumentacyjny przyjmuje “zlecenia” na wykonanie dokumentów. Zlecenia przychodzą od managerów produktów i zespół oddelegowuje jedną lub więcej osób, żeby wypełnić zlecenie. Agencja może być częścią firmy, lub zewnętrznym usługodawcą.
Często zlecenie rusza pod koniec cyklu produkcyjnego, to znaczy na przykład miesiąc przed końcem projektu trwającego rok. Technical writerzy przydzieleni do zadania przeprowadzają wtedy wywiady z kim trzeba, projektują dokument, opiniują, piszą, znowu opiniują, publikują i zostawiają sprawę do czasu, kiedy zostaną wezwani ponownie.
W tym samym modelu technical writer może też być przypisany do kilku projektów na stałe. Wtedy ma większą wiedzę o każdym z produktów i ich odbiorcach, ale nie ma na tyle pracy, żeby poświęcić cały czas jednemu z nich. Technical writer nie jest uważany za część zespołu a odpowiedzialność i przydział czasu zależy od jego managera.
Który model wybrać?
Bardzo dużo zależy od cyklu projektu.
Jeżeli projekt trwa długo, na przykład 6 miesięcy lub dłużej, to model agencyjny może sprawdzić się dobrze. Zwłaszcza, jeżeli przez większość czasu nie ma zmian, które powinny się znaleźć w dokumentacji.
Na przykład, zespół programistów pracuje nad modelem danych, migruje do nowej bazy i poprawia infrastrukturę, ale nie ma to wpływu na interfejs użytkownika. Dopiero pod koniec cyklu zespół może dodawać nowe funkcjonalności dla użytkownika i nie doda ich bardzo dużo. Dokumentacja dla użytkownika nie potrzebuje uwagi przez ten cały czas, a technical writer w zespole nie miałby nic do roboty.
Jeżeli zespół pracuje w krótkich sprintach, to technical writer musi się stać członkiem zespołu, żeby móc szybko reagować na zmiany.
Na przykład, sprint trwa dwa tygodnie i na koniec zespół zmienił działanie czterech różnych komponentów produktu. Technical writer z zewnątrz może przyjść na demo i zobaczyć zmiany, a potem nanieść je w dokumentacji. Tylko niestety demo jest tuż przed publikacją, więc musimy się liczyć z tym, że dokumentacja będzie przez jakiś czas nieaktualna.
Oczywiście zespół mógłby w trakcie pracy dawać znać zewnętrznemu writerowi jakie zmiany nadchodzą, ale to będzie kosztowało ich czas. A poza tym do samego końca nie będzie wiadomo jaki jest końcowy efekt ich pracy.
Jest wiele innych czynników decydujących o wyborze. Żeby nie marnować zbyt wielu akapitów na wijące się dyskusje, wypiszę kilka z nich w podpunktach:
- Kultura wymiany wiedzy w firmie
- Budżet
- Poziom skomplikowania produktu
- Dostępność zewnętrznych agencji
- Dostępność technical writerów do rekrutacji
- Wartość biznesowa dokumentacji technicznej
- Rozmieszczenie członków zespołu - agencja może się lepiej sprawdzić w koordynacji zespołów rozproszonych po świecie