W majowym numerze magazynu Design News opublikowany zosta\u0142 artyku\u0142 pt.: ?Dokumentacja techniczna produktu jako istotny element jego cyklu \u017cycia?, stanowi\u0105cy pierwszy materia\u0142 z cyklu tematycznego po\u015bwi\u0119conego zagadnieniu zarz\u0105dzania cyklem \u017cycia informacji w przedsi\u0119biorstwie przemys\u0142owym. Z jednej strony, by\u0142 on pr\u00f3b\u0105 zdefiniowania poj\u0119cia dobrej dokumentacji produktu (instrukcji obs\u0142ugi, materia\u0142\u00f3w serwisowych itp.). Z drugiej opisywa\u0142 w spos\u00f3b stosunkowo og\u00f3lny mo\u017cliwe rozwi\u0105zania usprawniaj\u0105ce proces tworzenia i zarz\u0105dzania tak\u0105 dokumentacj\u0105 ze szczeg\u00f3lnym uwzgl\u0119dnieniem narz\u0119dzia informatycznego, jakim mo\u017ce by\u0107 system CMS (Content Management System ? system zarz\u0105dzania tre\u015bci\u0105<\/strong><\/p>\n

\nSZYMON MALECKI<\/strong> jest dyrektorem zarz\u0105dzaj\u0105cym euroscript Polska<\/em><\/p>\n

\nPrzyszed\u0142 czas na zaprezentowanie konkretnych przyk\u0142ad\u00f3w takiego rozwi\u0105zania. Oto pierwszy z nich.<\/p>\n

\nKlient<\/strong><\/p>\n

\nNiemiecka firma produkuj\u0105ca znane na ca\u0142ym \u015bwiecie maszyny do przemys\u0142u tekstylnego zatrudnia w swojej g\u0142\u00f3wnej siedzibie 350 os\u00f3b. W okresie mi\u0119dzy rokiem 1999 a 2002, w kt\u00f3rym podj\u0119te zosta\u0142y kluczowe<\/p>\n

dla naszego przypadku kroki modernizacyjne, firma odnotowywa\u0142a b\u0142yskawiczny wzrost sprzeda\u017cy na rynkach \u015bwiatowych ? od oko\u0142o 70 do prawie dok\u0142adnie 120 milion\u00f3w Euro. Obecna by\u0142a (i jest) bezpo\u015brednio lub za po\u015brednictwem biur handlowych we wszystkich wa\u017cniejszych dla swojej bran\u017cy krajach \u015bwiata.<\/p>\n

\nProduktami firmy s\u0105, jak ju\u017c wspomniano, maszyny wykorzystywane w przemy\u015ble tekstylnym. Specyfik\u0105 podstawowych linii produkcyjnych Klienta jest ich modu\u0142owo\u015b\u0107. W du\u017cym uproszczeniu mo\u017cna powiedzie\u0107, \u017ce istnieje w ka\u017cdej z nich pewna ?maszyna- matka?, stanowi\u0105ca element podstawowy i najwa\u017cniejszy, nazwijmy go X, niemniej jednak ka\u017cdy odbiorca konkretnej maszyny otrzymuje pewien, dostosowany do swoich potrzeb, ?skrojony na miar\u0119? wariant ? np. X.1., X.2., X.3., itd.<\/p>\n

\nSytuacja wyj\u015bciowa ? problem(y)<\/strong><\/p>\n

\nProces redagowania dokumentacji technicznej odbywa\u0142 si\u0119 w firmie od 1989 w oparciu o narz\u0119dzia do DTP (PageMaker) oraz system do sk\u0142adu wsparty baz\u0105 danych. <\/p>\n

\nO ile w pocz\u0105tkowej fazie by\u0142a to wystarczaj\u0105ca dla firmy forma pracy nad dokumentacj\u0105, o tyle w obliczu b\u0142yskawicznego rozwoju firmy pojawi\u0142y si\u0119 coraz bardziej przybieraj\u0105ce na sile problemy.<\/p>\n

\nCykl \u017cycia danej konfiguracji maszyny ulega\u0142 skr\u00f3ceniu, przez co rozd\u017awi\u0119k mi\u0119dzy aktualn\u0105 konfiguracj\u0105 maszyny, a udost\u0119pnian\u0105 do niej dokumentacj\u0105 techniczn\u0105 by\u0142 coraz wi\u0119kszy. Niezwykle trudne stawa\u0142o si\u0119 zarz\u0105dzanie wariantami dokumentacji, a udost\u0119pnienie dokumentacji \u017ar\u00f3d\u0142owej i obcoj\u0119zycznej na czas okazywa\u0142o si\u0119 coraz mniej realne.<\/p>\n

\nPonadto brakowa\u0142o w firmie w\u0142a\u015bciwego styku pomi\u0119dzy procesem tworzenia dokumentacji oryginalnej, a procesami t\u0142umaczenia dokument\u00f3w na inne j\u0119zyki, czego bezpo\u015brednim skutkiem by\u0142 gwa\u0142towny wzrost koszt\u00f3w t\u0142umacze\u0144.<\/p>\n

\nRozwi\u0105zanie<\/strong><\/p>\n

\nW obliczu takiej sytuacji w roku 2001 podj\u0119to w firmie decyzj\u0119 o wdro\u017ceniu perspektywicznego systemu redakcyjnego.<\/p>\n

\nPierwszym etapem wdro\u017cenia by\u0142a szczeg\u00f3\u0142owa analiza procesu redagowania dokumentacji przez konsultant\u00f3w, dokonana w \u015bcis\u0142ej wsp\u00f3\u0142pracy z pracownikami klienta. Przy jej wykonywaniu oparto si\u0119 na kilku podstawowych za\u0142o\u017ceniach.<\/p>\n

\nPierwszym z nich by\u0142a mo\u017cliwo\u015b\u0107 wielokrotnego wykorzystania raz zredagowanych tre\u015bci. Oczywi\u015bcie podstawowym warunkiem wielokrotnego wykorzystania informacji jest mo\u017cliwo\u015b\u0107 jej odnalezienia. Co za tym idzie konieczne by\u0142o przemy\u015blenie odpowiednio funkcjonuj\u0105cego modu\u0142u wyszukiwania. Kolejnym za\u0142o\u017ceniem przy\u015bwiecaj\u0105cym analizie przedwdro\u017ceniowej by\u0142o umo\u017cliwienie zarz\u0105dzania wariantami i wersjami modu\u0142\u00f3w informacji. Wreszcie ? zw\u0142aszcza ze wzgl\u0119du na procesy t\u0142umaczeniowe ? konieczne by\u0142o zapewnienie mo\u017cliwo\u015bci \u015bledzenia przyczyn i przebiegu zmian w procesie redagowania dokument\u00f3w.<\/p>\n

\nDo wdro\u017cenia tak zaprojektowanego rozwi\u0105zania wybrano system redakcyjny firmy Schema GmbH, oparty na technologii XML i w swoich zasadniczych zr\u0119bach oparty o 6 sk\u0142adnik\u00f3w ? baz\u0119 danych XML, baz\u0119 danych grafik oraz baz\u0119 danych informacji wielokrotnego u\u017cytku, zasadniczy ?rdze\u0144? systemu, jakim jest modu\u0142 STDM3, a tak\u017ce edytor Schema Script i modu\u0142 t\u0142umaczeniowy wsp\u00f3\u0142pracuj\u0105cy z baz\u0105 pami\u0119ci t\u0142umaczeniowej firmy Trados.<\/p>\n

\nDokonano istotnych zmian w samej organizacji procesu, dopracowuj\u0105c si\u0119 klarownego podzia\u0142u zada\u0144. Samo redagowanie oraz t\u0142umaczenie dokumentacji zosta\u0142o przekazane w gesti\u0119 us\u0142ugodawcy zewn\u0119trznego, za\u015b dzia\u0142 redakcji technicznej po stronie Klienta przej\u0105\u0142 rol\u0119 koordynatora procesu i wsp\u00f3\u0142pracy obu jego uczestnik\u00f3w z trzecim, jakim by\u0142 dzia\u0142 bada\u0144 i rozwoju Klienta, dostarczaj\u0105cy informacji \u017ar\u00f3d\u0142owych do tworzenia dokumentacji.<\/p>\n

\nWsp\u00f3lnie z us\u0142ugodawc\u0105 zewn\u0119trznym zredagowano podr\u0119cznik redakcyjny zawieraj\u0105cy komplet niezwykle skrupulatnie uzgodnionych zasad pisowni, doboru terminologii, sposobu komponowania zda\u0144, formu\u0142owania akapit\u00f3w przeznaczonych dla wszystkich bior\u0105cych udzia\u0142 w procesie redaktor\u00f3w. Proces tworzenia struktury dokumentacji zosta\u0142 podzielony na 3 zasadnicze fazy:<\/p>\n

\nFAZA 1 <\/strong><\/p>\n

\nUtworzenie podstawowej struktury informacji (rodzaje informacji)<\/p>\n

\nFAZA 2<\/strong><\/p>\n

\nWype\u0142nienie rodzaj\u00f3w informacji jednostkami tre\u015bci (modularyzacja)<\/p>\n

\nFAZA 3<\/strong><\/p>\n

\nStruktura informacji gotowej dokumentacji (fragment)<\/p>\n

\nZa niezwykle istotny uznano tak\u017ce proces wprowadzania i utrzymywania metainformacji. Ka\u017cdy modu\u0142 musia\u0142 by\u0107 opisany przez redaktora na poziomie redakcyjnym (status obowi\u0105zywania informacji, wariant, istotno\u015b\u0107 zmian w t\u0142umaczeniu, itp.) oraz autora na poziomie zapisywania (autor, rodzaj informacji, data zmiany, ID itp.). Tylko w ten spos\u00f3b p\u00f3\u017aniejsze wyszukiwanie odpowiedniej informacji mog\u0142o by\u0107 zako\u0144czone sukcesem i tylko tak stosowanie wielokrotnie raz zredagowanej tre\u015bci mog\u0142o mie\u0107 sens.<\/p>\n

\nKorzy\u015bci<\/strong><\/p>\n

\nPierwsz\u0105 i podstawow\u0105 korzy\u015b\u0107 naj\u0142atwiej jest wyrazi\u0107 w liczbach.<\/p>\n

\nJakie by\u0142y efekty wdro\u017cenia? Firma produkowa\u0142a w owym czasie 22 maszyny i ich warianty z pe\u0142n\u0105 dokumentacj\u0105 techniczn\u0105. Oznacza\u0142o to, \u017ce w j\u0119zyku \u017ar\u00f3d\u0142owym (j\u0119zyk niemiecki) istnia\u0142o 10 151 stron dokumentacji. Po wdro\u017ceniu systemu okaza\u0142o si\u0119, \u017ce efektywnych stron netto w j\u0119zyku \u017ar\u00f3d\u0142owym by\u0142o zaledwie 3 159. Jak \u0142atwo policzy\u0107 w przypadku konieczno\u015bci wykonania t\u0142umacze\u0144 na 10 j\u0119zyk\u00f3w obcych oszcz\u0119dno\u015b\u0107 mo\u017ce si\u0119gn\u0105\u0107 w tym konkretnym przypadku nawet 70 000 stron. Oczywi\u015bcie obliczenia tego typu trzeba traktowa\u0107 bardzo ostro\u017cnie, ale nawet przy takim za\u0142o\u017ceniu, oszcz\u0119dno\u015bci wielokrotnie przewy\u017cszaj\u0105 koszt wdro\u017cenia systemu i licencji.<\/p>\n

\nOszcz\u0119dno\u015bci widoczne w liczbach to jednak nie jedyne korzy\u015bci z opisywanego wdro\u017cenia. Kolejn\u0105 jest oszcz\u0119dno\u015b\u0107 czasu. Dzi\u0119ki \u0142atwemu, przejrzystemu systemowi zarz\u0105dzania informacj\u0105, a tak\u017ce sprz\u0119\u017ceniu z modu\u0142ami t\u0142umaczeniowymi, znacznie skraca si\u0119 czas reakcji na zapotrzebowanie na now\u0105 wersje dokumentu do kolejnego wariantu maszyny. W idealnym przypadku, mo\u017cliwe jest nawet wygenerowanie nowego dokumentu bez konieczno\u015bci napisania ani jednego s\u0142owa, a tylko poprzez odpowiednie wykorzystanie ju\u017c istniej\u0105cych modu\u0142\u00f3w.<\/p>\n

\nWzros\u0142a tak\u017ce znacz\u0105co jako\u015b\u0107 wsparcia dla klient\u00f3w firmy. Dzi\u0119ki efektywnemu wykorzystaniu zasady jednego \u017ar\u00f3d\u0142a i niezale\u017cno\u015bci tre\u015bci od formatu, mo\u017cliwe by\u0142o wykorzystanie tych samych modu\u0142\u00f3w r\u00f3wnocze\u015bnie w formie PDF dost\u0119pnego na stronie internetowej i w komputerach dzia\u0142u obs\u0142ugi klienta, udost\u0119pnienie dokumentu w formacie html, stworzenie narz\u0119dzia pomocy online (troubleshooting) i szybkie drukowanie podr\u0119cznika u\u017cytkownika.<\/p>\n

\nKonsekwencja przy wykorzystaniu zasady jednego \u017ar\u00f3d\u0142a informacji przynosi tak\u017ce inne, nie mniej wa\u017cne korzy\u015bci. Klient otrzymuje dzi\u0119ki temu klarown\u0105, sp\u00f3jn\u0105 i w\u0142a\u015bciwie ustrukturyzowan\u0105 informacj\u0119. Udost\u0119pnianie informacji i zarz\u0105dzanie ni\u0105 staje si\u0119 przejrzyste i proste.<\/p>\n

\nNast\u0119pne kroki<\/strong><\/p>\n

\nObecnie klient znajduje si\u0119 w fazie migracji do nowej wersji systemu ? Schema ST4. Projekt realizowany jest przez dotychczasowego partnera, a sam proces u\u017cytkowania aplikacji oparty b\u0119dzie o atrakcyjn\u0105<\/p>\n

z punktu widzenia ekonomicznego zasad\u0119 ASP (application service providing), dzi\u0119ki kt\u00f3remu Klient ?wynajmuje? system pozostaj\u0105cy w\u0142asno\u015bci\u0105 us\u0142ugodawcy.<\/p>\n","protected":false},"excerpt":{"rendered":"

W majowym numerze magazynu Design News opublikowany zosta\u0142 artyku\u0142 pt.: ?Dokumentacja techniczna produktu jako istotny element jego cyklu \u017cycia?, stanowi\u0105cy pierwszy materia\u0142 z cyklu tematycznego po\u015bwi\u0119conego zagadnieniu zarz\u0105dzania cyklem \u017cycia informacji w przedsi\u0119biorstwie przemys\u0142owym. Z jednej strony, by\u0142 on pr\u00f3b\u0105 zdefiniowania poj\u0119cia dobrej dokumentacji produktu (instrukcji obs\u0142ugi, materia\u0142\u00f3w serwisowych itp.). Z drugiej opisywa\u0142 w spos\u00f3b stosunkowo og\u00f3lny mo\u017cliwe rozwi\u0105zania usprawniaj\u0105ce proces tworzenia i zarz\u0105dzania tak\u0105 dokumentacj\u0105 ze szczeg\u00f3lnym uwzgl\u0119dnieniem narz\u0119dzia informatycznego, jakim mo\u017ce by\u0107 system CMS (Content Management System ? system zarz\u0105dzania tre\u015bci\u0105<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_mi_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[],"tags":[157],"class_list":["post-2145","post","type-post","status-publish","format-standard","tag-igus"],"_links":{"self":[{"href":"https:\/\/www.designnews.pl\/wp-json\/wp\/v2\/posts\/2145","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.designnews.pl\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.designnews.pl\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.designnews.pl\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/www.designnews.pl\/wp-json\/wp\/v2\/comments?post=2145"}],"version-history":[{"count":0,"href":"https:\/\/www.designnews.pl\/wp-json\/wp\/v2\/posts\/2145\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.designnews.pl\/wp-json\/wp\/v2\/media?parent=2145"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.designnews.pl\/wp-json\/wp\/v2\/categories?post=2145"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.designnews.pl\/wp-json\/wp\/v2\/tags?post=2145"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}