W majowym numerze magazynu Design News opublikowany został artykuł pt.: „Dokumentacja techniczna produktu jako istotny element jego cyklu życia”, stanowiący pierwszy materiał z cyklu tematycznego poświęconego zagadnieniu zarządzania cyklem życia informacji w przedsiębiorstwie przemysłowym. Z jednej strony, był on próbą zdefiniowania pojęcia dobrej dokumentacji produktu (instrukcji obsługi, materiałów serwisowych itp.). Z drugiej opisywał w sposób 
stosunkowo ogólny możliwe rozwiązania usprawniające proces tworzenia i zarządzania taką dokumentacją ze szczególnym uwzględnieniem narzędzia informatycznego, jakim może być system CMS (Content Management System – system zarządzania treścią
SZYMON MALECKI jest dyrektorem zarządzającym euroscript Polska
Przyszedł czas na zaprezentowanie konkretnych przykładów takiego rozwiązania. Oto pierwszy z nich.
Klient
Niemiecka firma produkująca znane na całym świecie maszyny do przemysłu tekstylnego zatrudnia w swojej głównej siedzibie 350 osób. W okresie między rokiem 1999 a 2002, w którym podjęte zostały kluczowe
dla naszego przypadku kroki modernizacyjne, firma odnotowywała błyskawiczny wzrost sprzedaży na rynkach światowych – od około 70 do prawie dokładnie 120 milionów Euro. Obecna była (i jest) bezpośrednio lub za pośrednictwem biur handlowych we wszystkich ważniejszych dla swojej branży krajach świata.
Produktami firmy są, jak już wspomniano, maszyny wykorzystywane w przemyśle tekstylnym. Specyfiką podstawowych linii produkcyjnych Klienta jest ich modułowość. W dużym uproszczeniu można powiedzieć, że istnieje w każdej z nich pewna „maszyna- matka”, stanowiąca element podstawowy i najważniejszy, nazwijmy go X, niemniej jednak każdy odbiorca konkretnej maszyny otrzymuje pewien, dostosowany do swoich potrzeb, „skrojony na miarę” wariant – np. X.1., X.2., X.3., itd.
Sytuacja wyjściowa – problem(y)
Proces redagowania dokumentacji technicznej odbywał się w firmie od 1989 w oparciu o narzędzia do DTP (PageMaker) oraz system do składu wsparty bazą danych.
O ile w początkowej fazie była to wystarczająca dla firmy forma pracy nad dokumentacją, o tyle w obliczu błyskawicznego rozwoju firmy pojawiły się coraz bardziej przybierające na sile problemy.
Cykl życia danej konfiguracji maszyny ulegał skróceniu, przez co rozdźwięk między aktualną konfiguracją maszyny, a udostępnianą do niej dokumentacją techniczną był coraz większy. Niezwykle trudne stawało się zarządzanie wariantami dokumentacji, a udostępnienie dokumentacji źródłowej i obcojęzycznej na czas okazywało się coraz mniej realne.
Ponadto brakowało w firmie właściwego styku pomiędzy procesem tworzenia dokumentacji oryginalnej, a procesami tłumaczenia dokumentów na inne języki, czego bezpośrednim skutkiem był gwałtowny wzrost kosztów tłumaczeń.
Rozwiązanie
W obliczu takiej sytuacji w roku 2001 podjęto w firmie decyzję o wdrożeniu perspektywicznego systemu redakcyjnego.
Pierwszym etapem wdrożenia była szczegółowa analiza procesu redagowania dokumentacji przez konsultantów, dokonana w ścisłej współpracy z pracownikami klienta. Przy jej wykonywaniu oparto się na kilku podstawowych założeniach.
Pierwszym z nich była możliwość wielokrotnego wykorzystania raz zredagowanych treści. Oczywiście podstawowym warunkiem wielokrotnego wykorzystania informacji jest możliwość jej odnalezienia. Co za tym idzie konieczne było przemyślenie odpowiednio funkcjonującego modułu wyszukiwania. Kolejnym założeniem przyświecającym analizie przedwdrożeniowej było umożliwienie zarządzania wariantami i wersjami modułów informacji. Wreszcie – zwłaszcza ze względu na procesy tłumaczeniowe – konieczne było zapewnienie możliwości śledzenia przyczyn i przebiegu zmian w procesie redagowania dokumentów.
Do wdrożenia tak zaprojektowanego rozwiązania wybrano system redakcyjny firmy Schema GmbH, oparty na technologii XML i w swoich zasadniczych zrębach oparty o 6 składników – bazę danych XML, bazę danych grafik oraz bazę danych informacji wielokrotnego użytku, zasadniczy „rdzeń” systemu, jakim jest moduł STDM3, a także edytor Schema Script i moduł tłumaczeniowy współpracujący z bazą pamięci tłumaczeniowej firmy Trados.
Dokonano istotnych zmian w samej organizacji procesu, dopracowując się klarownego podziału zadań. Samo redagowanie oraz tłumaczenie dokumentacji zostało przekazane w gestię usługodawcy zewnętrznego, zaś dział redakcji technicznej po stronie Klienta przejął rolę koordynatora procesu i współpracy obu jego uczestników z trzecim, jakim był dział badań i rozwoju Klienta, dostarczający informacji źródłowych do tworzenia dokumentacji.
Wspólnie z usługodawcą zewnętrznym zredagowano podręcznik redakcyjny zawierający komplet niezwykle skrupulatnie uzgodnionych zasad pisowni, doboru terminologii, sposobu komponowania zdań, formułowania akapitów przeznaczonych dla wszystkich biorących udział w procesie redaktorów. Proces tworzenia struktury dokumentacji został podzielony na 3 zasadnicze fazy:
FAZA 1
Utworzenie podstawowej struktury informacji (rodzaje informacji)
FAZA 2
Wypełnienie rodzajów informacji jednostkami treści (modularyzacja)
FAZA 3
Struktura informacji gotowej dokumentacji (fragment)
Za niezwykle istotny uznano także proces wprowadzania i utrzymywania metainformacji. Każdy moduł musiał być opisany przez redaktora na poziomie redakcyjnym (status obowiązywania informacji, wariant, istotność zmian w tłumaczeniu, itp.) oraz autora na poziomie zapisywania (autor, rodzaj informacji, data zmiany, ID itp.). Tylko w ten sposób późniejsze wyszukiwanie odpowiedniej informacji mogło być zakończone sukcesem i tylko tak stosowanie wielokrotnie raz zredagowanej treści mogło mieć sens.
Korzyści
Pierwszą i podstawową korzyść najłatwiej jest wyrazić w liczbach.
Jakie były efekty wdrożenia? Firma produkowała w owym czasie 22 maszyny i ich warianty z pełną dokumentacją techniczną. Oznaczało to, że w języku źródłowym (język niemiecki) istniało 10 151 stron dokumentacji. Po wdrożeniu systemu okazało się, że efektywnych stron netto w języku źródłowym było zaledwie 3 159. Jak łatwo policzyć w przypadku konieczności wykonania tłumaczeń na 10 języków obcych oszczędność może sięgnąć w tym konkretnym przypadku nawet 70 000 stron. Oczywiście obliczenia tego typu trzeba traktować bardzo ostrożnie, ale nawet przy takim założeniu, oszczędności wielokrotnie przewyższają koszt wdrożenia systemu i licencji.
Oszczędności widoczne w liczbach to jednak nie jedyne korzyści z opisywanego wdrożenia. Kolejną jest oszczędność czasu. Dzięki łatwemu, przejrzystemu systemowi zarządzania informacją, a także sprzężeniu z modułami tłumaczeniowymi, znacznie skraca się czas reakcji na zapotrzebowanie na nową wersje dokumentu do kolejnego wariantu maszyny. W idealnym przypadku, możliwe jest nawet wygenerowanie nowego dokumentu bez konieczności napisania ani jednego słowa, a tylko poprzez odpowiednie wykorzystanie już istniejących modułów.
Wzrosła także znacząco jakość wsparcia dla klientów firmy. Dzięki efektywnemu wykorzystaniu zasady jednego źródła i niezależności treści od formatu, możliwe było wykorzystanie tych samych modułów równocześnie w formie PDF dostępnego na stronie internetowej i w komputerach działu obsługi klienta, udostępnienie dokumentu w formacie html, stworzenie narzędzia pomocy online (troubleshooting) i szybkie drukowanie podręcznika użytkownika.
Konsekwencja przy wykorzystaniu zasady jednego źródła informacji przynosi także inne, nie mniej ważne korzyści. Klient otrzymuje dzięki temu klarowną, spójną i właściwie ustrukturyzowaną informację. Udostępnianie informacji i zarządzanie nią staje się przejrzyste i proste.
Następne kroki
Obecnie klient znajduje się w fazie migracji do nowej wersji systemu – Schema ST4. Projekt realizowany jest przez dotychczasowego partnera, a sam proces użytkowania aplikacji oparty będzie o atrakcyjną
z punktu widzenia ekonomicznego zasadę ASP (application service providing), dzięki któremu Klient „wynajmuje” system pozostający własnością usługodawcy.
