Cykl życia dokumentacji
Oprócz cyklu w jakim nasza dokumentacja jest wytwarzana, istnieje jeszcze większy cykl, który określa jej cały żywot, od poczęcia aż po grób i życie pozagrobowe.
Dzieciństwo i dojrzewanie
Niezależnie od tego czy rozwijamy dokumentację zwinnie czy wodospadowo, na początku musi być niedojrzała. Nasza dokumentacja nie została jeszcze przeczytana przez klientów, więc nie mamy od nich feedbacku1. Nie opisaliśmy jeszcze wszystkiego, bo zaczęliśmy od najwyższych priorytetów. Nasz produkt jeszcze się rozwija, a dokumentacja wraz z nim.
Ten okres jest ważny, bo pozyskujemy nowych klientów, dlatego powinniśmy szybko reagować na potrzeby, odpowiadać personalnie i dokładać starań. W zależności od skali, nasz technical writer musi poświęcić dokumentacji cały swój czas, lub nasz zespół musi oddelegować do projektu więcej osób, lub zaangażować najlepszych.
Dorosłość
Teraz nasza dokumentacja i produkt są w miarę stabilne. Skupiamy się na utrzymaniu naszych treści. Naprawiamy głównie defekty i raczej nie dokonujemy jakichś rewolucyjnych zmian. Czasem usuwamy treści dotyczące funkcjonalności, których już nie wspieramy. W tym okresie możemy przekierowywać naszych writerów do innych projektów.
Schyłek
W końcu nasz produkt przechodzi na emeryturę, a wraz z nim, dokumentacja. Napiszmy o tym! Jeżeli nie będziemy już wspierać produktu, to dajmy o tym znać użytkownikom, napiszmy dlaczego i podziękujmy im za lata współpracy.
Jeżeli zastępujemy produkt innym, to napiszmy użytkownikom dlaczego warto się przenieść, jakie będą mieli z tego korzyści. Napiszmy też jak skutecznie się przemigrować, i zapewnijmy, że wszystko będzie w porządku.
- Słowo “feedback”, to kolejne, obok “designu”, konkretne słowo, którego potrzebujemy. “Opinia” czy “informacja zwrotna” nie oddają w pełni znaczenia, dlatego zdecydowałem się po raz kolejny nie unikać anglicyzmów.↩