Przejdź do głównej zawartości

Zarządzanie dokumentacją - grzechy główne

· 5 min aby przeczytać

Nie raz zdarza się nam siedzieć godzinami i przeszukiwać bezmiar zasobów zgromadzonych treści w poszukiwaniu tej jednej, najważniejszej, która, teoretycznie, powinna pojawić się na ekranie monitora po kilku kliknięciach. Im dłużej szukamy, tym większa w nas frustracja i złość, bo przecież nasza baza czy Internet są tak dobrze zorganizowane. Jednak czy na pewno tak jest skoro nie możemy odszukać tego, co nam jest potrzebne?

Ludzie na całym świecie spędzają ogromną ilość czasu na tworzeniu, dzieleniu się, znajdowaniu czy aktualizowaniu treści. Filtrujemy pocztę, foldery z dysków, szperamy w Internecie i nie zawsze czas temu poświęcony oraz wynik naszego działania jest satysfakcjonujący. Dotyczy to zarówno treści rozrywkowych, jak i tych o wiele ważniejszych, użytkowych, a więc i dokumentacji, z której korzystają pracownicy większości organizacji. Owa dokumentacja jest w firmie niezbędna, jednak nieefektywne nią zarządzanie prowadzi nie tylko do frustracji pracowników, ale jest też przyczyną błędów, opóźnień, nieporozumień co zazwyczaj w prosty sposób przelicza się na straty finansowe.

Co zrobić, aby uniknąć chaosu w dokumentacji? Najlepiej sprawdzić, czy każdy z dokumentów przepływających przez firmę - trafiający z zewnątrz lub generowany przez pracowników - jest przydatny. Te, które przejdą naszą ocenę pozytywnie powinny być odpowiednio segregowane i archiwizowane. Jeśli za dokumentację w danej jednostce odpowiedzialna jest osoba ją tworząca, czyli my, Technical Writerzy, możemy ułatwić sobie życie korzystając z systemów do zarządzania dokumentami (DMS). Mamy tu do wyboru programy open source jak na przykład Open KM oraz produkty komercyjne jak choćby Microsoft SharePoint. Ideą za nimi przemawiającą jest minimalizacja czasu, jaki spędzamy na wyszukiwaniu informacji oraz przetwarzaniu jej, a co za tym idzie, zwiększenie czasu, jaki możemy spędzić na tworzeniu dalszej dokumentacji czyli pracować bardziej efektywnie.

Posiadamy więc odpowiedni program, teoretycznie oszczędzamy czas, zabieramy się ochoczo za kolejny projekt i nagle okazuje się, że wciąż mamy problem ze znalezieniem tego co nam potrzebne. Co robimy źle? Prawdopodobnie mimowolnie popełniamy błędy, które skutkują ciągle narastającym bałaganem w zasobach dokumentacji. Najczęstrzą ich przyczyną jest niewiedza, bo przecież większość z nas nie była szkolona w tym kierunku, a nasze działania zazwyczaj są ciągle powielane i wchodzą nam w krew.

Najczęstsze błędy w zarządzaniu dokumentacją:

  1. Komu to jest w ogóle potrzebne? - Ojcem wszystkich błędów jakie popełnia się przy pracy z dokumentacją jest jej tworzenie bez jasnego określenia kto jest jej odbiorcą i jaki jest jej cel. Od tego bezwarunkowo powinno się zaczynać - robienie czegoś nie wiedząc dla kogo się to robi i co się właściwie chce osiągnąć w żadnej dziedzinie nie przynosi korzyści - technical writing nie jest tu żadnym wyjątkiem. Niestety, sporo firm o tym zapomina i dokumentacja powstaje w oparciu o bardzo ogólne założenia lub ich brak. Bez określonego celu jest "do wszystkiego". A jak coś jest do wszystkiego - wiadomo - zazwyczaj nie nadaje się do niczego.
  2. Ciągłe przesyłanie załączników w mailach - mamy informację, którą chcemy się z kimś podzielić, wysyłamy mail z załącznikiem. Chcemy poprosić kogoś o sprawdzenie napisanej przez nas dokumentacji, wysyłamy mail z załącznikiem. Otrzymujemy odpowiedzi, załącznik jest powielany, a w skrzynkach osób zainteresowanych, lub nie, tworzy się coraz większy chaos. Ktoś przesyła dokument dalej, ktoś inny nanosi na niego poprawki bez powiadomienia oryginalnego autora, jeszcze ktoś publikuje tak powstały twór lub wysyła go klientowi. W firmie zaczyna funkcjonować kilka “równoległych” dokumentów pod tym samym tytułem i po jakimś czasie sam autor traci rozeznanie, który jest tym właściwym. Pomocą w zorganizowaniu często rozsyłanych treści jest coraz popularniejsza chmura. Producenci oprogramowania oferują mnóstwo aplikacji bazujących na zasobach w chmurze, jak choćby Google Docs czy DropBox. Dzięki nim nie ma potrzeby wysyłać dokumentów w załącznikach - wystarczy podać lokalizację, a osoby zainteresowane otrzymają do niej dostęp.
  3. Brak aktualizacji to brak zaufania - dokumentację, czy to wewnętrzną, czy tą, którą tworzymy dla stałego klienta, powinno się aktualizować. Ile razy patrzyliśmy na datę ostatniej modyfikacji i stwierdzaliśmy, że dokument, który powstał pięć lat temu raczej nie ma w sobie nic aktualnego ani przydatnego? Przepisy, zasady działania, dodatki w oprogramowaniu czy same procedury tworzenia dokumentacji lubią się zmieniać z biegiem lat. Jeśli brakuje im odkurzenia i odświeżenia stają się źródłem informacji niepełnych, bądź nawet szkodliwych dla wizerunku firmy. Jeśli więc jakieś dokumenty nie są aktualizowane na bieżąco, powinny być odpowiednio zarchiwizowane lub usunięte. W innym wypadku korzystające z niej osoby stracą zaufanie nie tylko do samej dokumentacji, ale także całej firmy, którą ona reprezentuje.
  4. Klęska urodzaju - piszemy dokumentację, to nasza praca, która prędzej czy później staje się nawykiem. Mamy projekt - zasiadamy do niego i po prostu tworzymy to, co jest obecnie potrzebne. Rzadko kiedy zadajemy sobie pytanie czy aby ktoś już wcześniej czegoś takiego nie napisał, gdyż z góry zakładamy, ze nasz projekt jest jedyny i unikatowy. A może ktoś w firmie już stworzył coś podobnego na poczet innego projektu? Może warto najpierw zadać sobie trud i poszukać w zasobach firmy już istniejącą dokumentację? Może zamiast napisać nowy, wystarczy zaktualizować lub zaadaptować już istniejący tekst? Pozwoli to znacznie zmniejszyć ilość tworzonej treści i wprowadzi nowy, o wiele lepszy nawyk - najpierw szukam, potem tworzę.
  5. Czyj jest ten dokument? - Sporo firm nie praktykuje przechowywania informacji o aktualnym właścicielu danego dokumentu. Zazwyczaj milcząco zakłada się, że jest nim autor, ale co, gdy ten zwolni się, zmieni dział, dostanie awans albo przekwalifikuje się i do jego nowych obowiązków nie będzie już należało utrzymywanie dokumentacji? Taki bezpański dokument szybko przestanie być aktualny i będzie tylko zalegał w systemie. Być może za jakiś czas ktoś sobie o nim przypomni, ale wtedy może się okazać, że łatwiej napisać go od zera niż zaktualizować.

Zastanawiamy się jakie jeszcze błędy odnośnie zarządzania dokumentacją można popełniać. Może macie jakieś pomysły, albo doświadczenia z własnej pracy w branży? Chętnie poznamy Wasze opinie na ten temat.