Zespół, w którym obecnie uczestniczę, ma dość duże obroty, a członkowie zwykle przenoszą się do różnych projektów w ramach tej samej firmy. Obecnie naszym „szkoleniem” dla nowych członków jest powiązanie ich z głównym kontaktem (zazwyczaj ostatnią osobą, która ukończy szkolenie), która zapewni im praktyczne doświadczenie i zapyta więcej starszych programistów, czy nowi pracownicy zatrudniają mentora nie wie Daje to szansę na szybkie zaangażowanie nowego pracownika i prosi mentora o lepsze zrozumienie systemu.
Jednak, jak możesz sobie wyobrazić, ten styl szkolenia jest bardzo czasochłonny i nie zapewnia bardzo dobrego transferu wiedzy (rozpowszechniają się nieporozumienia, powiększają się luki).
Zadanie polegało na generowaniu dokumentacji i materiałów szkoleniowych dla naszych przyszłych nowych pracowników. Od czasu do czasu piszę teksty techniczne, ale są one przeznaczone dla użytkowników końcowych i są bardzo specyficzne z dużą ilością zrzutów ekranu i zajmują dużo czasu.
Tworzenie nowej dokumentacji dla nowych pracowników jest uważane za niski priorytet i mam obecnie tylko ~ 40 godzin, aby nad tym popracować. Dokumentowanie systemu obecnym sposobem, w jaki piszę dokumentację techniczną, ledwo zarysowałoby powierzchnię w 40 godzin. Zwłaszcza biorąc pod uwagę, że muszę dokumentować nie tylko bazę kodu, ale także wdrożenia i wsparcie.
Jak mogę szybko napisać dokumentację, aby jak najszybciej uzyskać informacje o nowych pracownikach bez poświęcania znacznej ilości czasu na pisanie dokumentacji?
Informacje dodatkowe:
Obecnie mamy zarówno wiki, jak i dokumentację szkoleniową, jednak obie są dość rzadkie.