Podstawowym zapisem przepisów Unii Europejskiej zawartych w tzw. dyrektywach nowego podejścia, w tym w szczególności Dyrektywy Maszynowej jest stwierdzenie, że dokumentacja techniczna urządzenia jest jego częścią składową, taką samą jak żarówka w reflektorze albo wał korbowy w silniku spalinowym. Powodem wadliwego funkcjonowania urządzenia (np. reflektora) może być spalona żarówka, ale możliwe jest też, że istniejąca dokumentacja techniczna w niewystarczający sposób opisuje niezbędne warunki, wymagane dla poprawnej pracy urządzenia
Samo dostosowanie się do wymogów prawnych, to jednak – co prawda konieczny i bezsporny – ale jedynie wstępny warunek dla tworzenia właściwej dokumentacji technicznej produktu. Dlatego dzisiaj coraz częściej mówi się o tym, że wysoka jakość dokumentacji może być decydującym orężem w walce o przewagę nad konkurencją.
Tym samym w najbardziej rozwiniętych organizacjach coraz częściej uznaje się, że jednym z najistotniejszych zagadnień procesu zarządzania cyklem życia produktu (Product Lifecycle Managament, PLM) jest zarządzanie cyklem życia informacji (Information Lifecycle Management ILM lub Document Lifecycle Management DLM).
Mówiąc krótko – jakość dokumentacji produktowej oraz sam proces jej tworzenia stanowią jeden z bardziej krytycznych elementów działalności każdego przedsiębiorstwa. W szczególności problem ten dotyczy branży maszynowej, wysokich technologii, sektora motoryzacji czy produkcji zbrojeniowej, a więc wszystkich tych gałęzi przemysłu, które komunikują się ze swoimi klientami za pośrednictwem instrukcji obsługi, instrukcji utrzymania czy dokumentacji serwisowej.
Czy można w takim razie zdefiniować pojęcie dobrej dokumentacji produktu?
Przy próbie odpowiedzi na to pytanie pod uwagę należy wziąć przede wszystkim dwa zróżnicowane spojrzenia – zewnętrzne, od strony Klienta czy Odbiorcy i wewnętrzne od strony producenta czy nadawcy.
Jakiej dokumentacji oczekuje Klient? Przede wszystkim prostej i czytelnej – chociaż dokumentacja techniczna to nie literatura popularna, nikt nie powiedział, że ma być trudna w odbiorze. Po drugie, Klient oczekuje, że dokumentacja będzie aktualna – cykl życia produktu ulega drastycznemu skróceniu, pojawiają się nowe warianty, udoskonalenia, Klient chce dysponować aktualnymi informacjami i mieć pewność, że przy zakupie maszyny X1v.1.1.1.2 nie otrzyma instrukcji obsługi maszyny X1v.1.1.1.0. Odbiorca oczekuje również dokumentacji pełnej, opisującej wszystko, czego chce się dowiedzieć. Jednym z najbardziej niedocenianych kryteriów oceny dokumentacji przez Klientów jest też jej spójność – zarówno w sensie zawartości jak i formy. Jeśli instrukcja obsługi do maszyny Porter 1 zawiera informacje o jej wszystkich funkcjach, a maszyna Porter 1.2 jest rozwinięciem maszyny Porter 1 to instrukcja obsługi maszyny Porter 1.2 powinna zawierać te same informacje co instrukcja do Porter 1 poszerzone o dodatkowe funkcje maszyny Porter 1.2. Co więcej jedna i druga instrukcja powinny wyglądać podobnie i być łatwe do porównania. Bardzo często autorzy dokumentacji zapominają także o konieczności dostosowania danej instrukcji i opisu do konkretnej grupy odbiorców – innych informacji spodziewa się doświadczony serwisant, od lat pracujący przy przeglądach maszyny Porter 1, a innej szef przedsiębiorstwa, który zastanawia się nad jej kupnem. Wreszcie, coraz częściej pojawia się wśród Klientów – odbiorców dokumentacji oczekiwanie dokumentacji łatwo dostępnej – Klient nie chce dziś czekać, aż równocześnie z maszyną na palecie dostarczy mu się opasły tom rysunków i tekstu. Woli wejść na stronę internetową firmy i ściągnąć plik PDF na swój komputer, albo przejść przez interaktywny program szkoleniowy.
Co chyba oczywiste, oczekiwanie wewnętrzne, a więc „nadawców” informacji zawartej w dokumentacji technicznej, są po części tożsame z oczekiwaniami Klientów, ale po części zdecydowanie się od nich różnią, zwłaszcza biorąc pod uwagę słynne powiedzenie, że punkt widzenia zależy od punktu siedzenia.
Jakiej dokumentacji chce Zarząd producenta? Zarząd oczekuje optymalnych nakładów i kosztów związanych z tworzeniem dokumentacji, jasnych i sprecyzowanych zasad jej tworzenia, dobrze zdefiniowanych zadań osób odpowiedzialnych za jej tworzenie, precyzyjnie określonych praw i obowiązków poszczególnych uczestników procesu – w tym prawa do wprowadzania zmian i ich zatwierdzania,.
Inna optyka rządzi oczekiwaniami działu marketingu i sprzedaży – dla nich najważniejsze są szybki dostęp do zawsze aktualnych informacji, odpowiedni format dokumentacji, lub jej części, umożliwiający szybkie stworzenie prezentacji na spotkanie z Klientem, ulotki reklamowej, prezentacji w Internecie czy materiału na szkolenie, pełna wielojęzyczność – jeśli Klienci firmy wymagają dokumentacji w swoim języku ojczystym.
Tym wszystkim oczekiwaniom sprostać musi autor, czy zespół autorów i redaktorów – dział dokumentacji technicznej. Aby tego dokonać musi zatroszczyć się o jasny podział obowiązków w ramach całej firmy i zespołu, o łatwość gromadzenia danych potrzebnych do stworzenia dokumentacji (wielość formatów elektronicznych różnych składników dokumentacji jest tu kluczowym problemem do rozwiązania), o prosty sposób generowania rozmaitych form dokumentacji w oparciu o te same źródła, ograniczenie dodatkowych czynności koniecznych do wygenerowania ostatecznego pakietu informacji, możliwość dynamicznej współpracy w ramach organizacji rozproszonej (jeśli w przygotowaniu jednego dokumentu bierze udział geograficznie rozproszony zespół redaktorów, albo na przykład tłumaczy) i oczywiście optymalne koszty przygotowania dokumentacji.
Podane powyżej zagadnienia zapewne nie wyczerpują definicji dobrej dokumentacji technicznej, wydaje się jednak, że dotykają przynajmniej podstawowych problemów związanych z tworzeniem i zarządzaniem cyklem życia informacji o produkcie w przedsiębiorstwie.
Dlatego niewątpliwie warto sobie zadać pytanie, czy wszystkie powyższe oczekiwania czy kryteria udaje się w naszym przedsiębiorstwie wypełnić.
W dzisiejszej rzeczywistości to jednak nie wystarczy. Trzeba działać. Możliwe jest wiele scenariuszy. Z doświadczenia wiadomo, że w przypadku stwierdzenia problemów jakościowych czy wydajnościowych (w tym przypadku w zakresie tworzenia dokumentacji i zarządzania nią) pierwszym naturalnym odruchem jest myśl o zwiększeniu zespołu, dodatkowych etatach, może większych zarobkach. Oczywiście można tak zrobić.
Wcześniej warto jednak albo przeanalizować procesy związane z zarządzaniem dokumentacją, albo zasięgnąć opinii zewnętrznych specjalistów, wyspecjalizowanych firm doradczych i outsourcingowych zajmujących się problemem od lat. Po gruntowanej analizie procesów biznesowych i próbie ich zoptymalizowania, zaproponują oni zapewne dobór narzędzia informatycznego pozwalającego na systemowe zaspokojenie potrzeb organizacji w zakresie redagowania i zarządzania dokumentacją techniczną, lub zaproponują oddanie procesu do realizacji firmie zewnętrznej (czego nie należy mylić z odebraniem zajęcia własnym autorom dokumentacji; dzieje się zwykle wręcz przeciwnie).
Jedną z ich sugestii może być wdrożenie systemu redakcyjnego klasy CMS (Content Management System). Nie chodzi tu jednak o popularne także w Polsce systemy do zarządzania zawartością stron internetowych czy portali, ale o specjalistyczne, dedykowane dla przemysłu profesjonalne narzędzie redakcyjne.
Jak funkcjonuje takie rozwiązanie?
Podstawowymi cechami charakteryzującymi systemy redakcyjne dedykowane do tworzenia dokumentacji technicznej są z jednej strony modularyzacja treści, a z drugiej oddzielenie zawartości od formatu, w jakim jest przechowywana.
Mówiąc w dużym uproszczeniu, tekst instrukcji podzielony zostaje na najmniejsze możliwe moduły informacji (na przykład opis konkretnej czynności „Podłączanie urządzenia do prądu” albo ostrzeżenie o niebezpieczeństwie), dzięki czemu osiągnięta zostaje jedna z podstawowych korzyści opisywanego rozwiązania, jaką jest możliwość wielokrotnego użycia tego samego modułu treści. Nie ma już potrzeby pisania każdej dokumentacji od nowa, albo stosowania obarczonego błędami i często niemożliwego technicznie „przeklejania” informacji z jednego dokumentu do drugiego. Raz sporządzona treść staje się dorobkiem możliwym do ponownego użycia. Co więcej, każda zmiana modułu automatycznie pojawia się we wszystkich dokumentach, w których moduł jest wykorzystywany. Nie trzeba chyba rzekonywać o rozmiarach oszczędności, jakie takie rozwiązanie może przynieść
Moduły treści są przechowywane w odpowiedniej, wspólnej dla wszystkich dokumentów bazie danych w formacie „zrozumiałym” dla wszystkich możliwych programów DTP, edytorów czy programów do obróbki stron internetowych. Dodatkowo posiadają one swoje opisy, tzw. metadane, pozwalające je sklasyfikować, a później wyszukiwać w bazie w razie potrzeby ich użycia. Jak wspomniano powyżej, instrukcja obsługi opracowywana jest na ogół na podstawie wielu danych źródłowych, pochodzących z różnych etapów prac nad produktem, różnych działów przedsiębiorstwa, i co najtrudniejsze, z różnych środowisk informatycznych – choćby rysunków typu AutoCad, plików graficznych programów do składu i tekstów pisanych w różnych edytorach tekstów. W opisanym rozwiązaniu różnorodność formatów nie ma znaczenia. Ponadto zapewniona jest spójność informacji, gdyż raz przygotowane moduły treści są wykorzystywane we wszystkich dokumentach.
Obok tych dwu podstawowych korzyści rozwiązanie typu CMS zapewnia także spójność treści. Zapewnie niejednemu przyszłemu Klientowi przyszło do głowy pytanie, dlaczego o tych samych elementach urządzenia spośród gamy produktów jednego dostawcy, instrukcja za każdym razem mówi innymi słowami, lub na coś innego zwraca uwagę. Zapewne w różnych fazach prac nad instrukcjami, pracowały nad nią różne osoby, które wzajemnie nie informowały się o swoich czynnościach. W opisywanym rozwiązaniu sytuacja taka nie jest możliwa, gdyż wszyscy uczestnicy procesu tworzenia instrukcji pracują na wspólnym materiale i automatycznie zapamiętują najbardziej aktualne, ostateczne wersje swej pracy.
Uzyskana zostaje także pełna transparentność procesu dla wszystkich jego uczestników z możliwością przypisania ról i powiązanych z nimi uprawnień, niezależnie od zlokalizowania poszczególnych osób czy działów. Dzięki temu możliwe jest zdefiniowanie klarownego przepływu zadań (workflow), w którym każdy zna swoje zadania, swoją rolę i kolejność wykonywania poszczególnych czynności.
Rozwiązania typu CMS są zwykle w pełni integrowalne z narzędziami IT wspierającymi procesy tłumaczenia. Aspekt ten nie jest dla wielu przedsiębiorstw, zwłaszcza produkujących na eksport, zagadnieniem obcym. Ważne jest, aby to, co tak dobrze staramy się opracować w języku oryginału, było równie dobre w języku odbiorców. Dzięki opisywanemu rozwiązaniu wersje w językach obcych są poddane dokładnie tak samo spójnemu i kontrolowanemu procesowi, jak teksty oryginalne.
W powyższym materiale podjęto próbę usystematyzowania wyznaczników prawidłowego zarządzania informacją o produkcie w przedsiębiorstwie. Przedstawiono także ogólnie korzyści płynące z wdrożenia w firmie specjalistycznych narzędzi informatycznyc wspomagających redagowanie dokumentacji technicznej.
Siłą rzeczy są to informacje stosunkowo ogólne. Aby ocenić faktyczną przydatność takich systemów, ale i dostrzec zagrożenia nimi związane konieczne będzie przedstawienie i rzeczowa analiza konkretnych przypadków ich zastosowania. Będzie ona tematem kolejnych artykułów na łamach Design News. Już teraz zapraszamy do lektury.
Autor: SZYMON MALECKI
