Wprowadzenie
Dla kogo jest ta książka?
Ta książka została napisana z myślą o osobach odpowiedzialnych za dokumentację w firmie. Nieważne czy jesteś na stanowisku kierowniczym i prowadzisz zespół, czy jesteś product ownerem i w Twoim produkcie nie ma jeszcze dokumentacji czy jesteś jedynym technical writerem w firmie. Jeżeli Twoim zadaniem jest kompleksowo zająć się dokumentacją, to ta książka jest dla Ciebie.
O czym jest ta książka?
Moim celem nie jest uczyć Cię dobrych praktyk pisania tekstów technicznych, mierzyć się z rozterkami językowymi i dyskutować o tym czy stawianie przecinka w danym miejscu ma sens. Dlatego ta książka nie wchodzi zbytnio w szczegóły, tylko w zwięzły sposób przedstawia aspekty dokumentacji, które wydają się istotne z punktu widzenia osoby zarządzającej nią w organizacji. Czytając ją, dowiesz się:
- Po co i komu jest potrzebna dokumentacja
- Jak kalkulować koszty i zwroty z inwestycji
- Jak przeanalizować potrzeby dokumentacyjne w produkcie (lub firmie)
- Kto powinien się zająć dokumentacją (umiejętności) i jak podzielić pracę (zespół)
- Jak zorganizować pracę zespołu dokumentacyjnego
- Jak mierzyć jakość i sukces dokumentacji
- Jak poprawiać istniejącą dokumentację
- Jaki jest cykl życia dokumentacji
- Jakich narzędzi używać
Po przeczytaniu tej książki możesz pogłębić wiedzę na poszczególne tematy lub znaleźć ludzi, którzy zajmą się szczegółami.