<\/p>\n

\nPodstawowym zapisem przepis\u00f3w Unii Europejskiej zawartych w tzw. dyrektywach nowego podej\u015bcia, w tym w szczeg\u00f3lno\u015bci Dyrektywy Maszynowej jest stwierdzenie, \u017ce dokumentacja techniczna urz\u0105dzenia jest jego cz\u0119\u015bci\u0105 sk\u0142adow\u0105, tak\u0105 sam\u0105 jak \u017car\u00f3wka w reflektorze albo wa\u0142 korbowy w silniku spalinowym. Powodem wadliwego funkcjonowania urz\u0105dzenia (np. reflektora) mo\u017ce by\u0107 spalona \u017car\u00f3wka, ale mo\u017cliwe jest te\u017c, \u017ce istniej\u0105ca dokumentacja techniczna w niewystarczaj\u0105cy spos\u00f3b opisuje niezb\u0119dne warunki, wymagane dla poprawnej pracy urz\u0105dzenia<\/strong><\/p>\n

\nSamo dostosowanie si\u0119 do wymog\u00f3w prawnych, to jednak ? co prawda konieczny i bezsporny ? ale jedynie wst\u0119pny warunek dla tworzenia w\u0142a\u015bciwej dokumentacji technicznej produktu. Dlatego dzisiaj coraz cz\u0119\u015bciej m\u00f3wi si\u0119 o tym, \u017ce wysoka jako\u015b\u0107 dokumentacji mo\u017ce by\u0107 decyduj\u0105cym or\u0119\u017cem w walce o przewag\u0119 nad konkurencj\u0105.<\/p>\n

\nTym samym w najbardziej rozwini\u0119tych organizacjach coraz cz\u0119\u015bciej uznaje si\u0119, \u017ce jednym z najistotniejszych zagadnie\u0144 procesu zarz\u0105dzania cyklem \u017cycia produktu (Product Lifecycle Managament, PLM) jest zarz\u0105dzanie\u00a0 cyklem \u017cycia informacji (Information Lifecycle Management ILM lub Document Lifecycle Management DLM).<\/p>\n

\nM\u00f3wi\u0105c kr\u00f3tko ? jako\u015b\u0107 dokumentacji produktowej oraz sam proces jej tworzenia stanowi\u0105 jeden z bardziej krytycznych element\u00f3w dzia\u0142alno\u015bci ka\u017cdego przedsi\u0119biorstwa. W szczeg\u00f3lno\u015bci problem ten dotyczy bran\u017cy maszynowej, wysokich technologii, sektora motoryzacji czy produkcji zbrojeniowej, a wi\u0119c wszystkich tych ga\u0142\u0119zi przemys\u0142u, kt\u00f3re komunikuj\u0105 si\u0119 ze swoimi klientami za po\u015brednictwem instrukcji obs\u0142ugi, instrukcji utrzymania czy dokumentacji serwisowej.<\/p>\n

\nCzy mo\u017cna w takim razie zdefiniowa\u0107 poj\u0119cie dobrej dokumentacji produktu?<\/strong><\/p>\n

\nPrzy pr\u00f3bie odpowiedzi na to pytanie pod uwag\u0119 nale\u017cy wzi\u0105\u0107 przede wszystkim dwa zr\u00f3\u017cnicowane spojrzenia ? zewn\u0119trzne, od strony Klienta czy Odbiorcy i wewn\u0119trzne od strony producenta czy nadawcy.<\/p>\n

\nJakiej dokumentacji oczekuje Klient? Przede wszystkim prostej i czytelnej ? chocia\u017c dokumentacja techniczna to nie literatura\u00a0popularna, nikt nie powiedzia\u0142, \u017ce ma by\u0107 trudna w odbiorze. Po drugie, Klient oczekuje, \u017ce dokumentacja b\u0119dzie aktualna ? cykl \u017cycia produktu ulega drastycznemu skr\u00f3ceniu, pojawiaj\u0105 si\u0119 nowe warianty, udoskonalenia, Klient chce dysponowa\u0107 aktualnymi informacjami i mie\u0107 pewno\u015b\u0107, \u017ce przy zakupie maszyny X1v.1.1.1.2 nie otrzyma instrukcji obs\u0142ugi maszyny X1v.1.1.1.0. Odbiorca oczekuje r\u00f3wnie\u017c dokumentacji pe\u0142nej, opisuj\u0105cej wszystko, czego chce si\u0119 dowiedzie\u0107. Jednym z najbardziej niedocenianych kryteri\u00f3w oceny dokumentacji przez Klient\u00f3w jest te\u017c jej sp\u00f3jno\u015b\u0107 ? zar\u00f3wno w sensie zawarto\u015bci jak i formy. Je\u015bli instrukcja obs\u0142ugi do maszyny Porter 1 zawiera informacje o jej wszystkich funkcjach, a maszyna Porter 1.2 jest rozwini\u0119ciem maszyny Porter 1 to instrukcja obs\u0142ugi maszyny Porter 1.2 powinna zawiera\u0107 te same informacje co instrukcja do Porter 1 poszerzone o dodatkowe funkcje maszyny Porter 1.2. Co wi\u0119cej jedna i druga instrukcja powinny wygl\u0105da\u0107 podobnie i by\u0107 \u0142atwe do por\u00f3wnania. Bardzo cz\u0119sto autorzy dokumentacji zapominaj\u0105 tak\u017ce o konieczno\u015bci dostosowania danej instrukcji i opisu do konkretnej grupy odbiorc\u00f3w ? innych informacji spodziewa si\u0119 do\u015bwiadczony serwisant, od lat pracuj\u0105cy przy przegl\u0105dach maszyny Porter 1, a innej szef przedsi\u0119biorstwa, kt\u00f3ry zastanawia si\u0119 nad jej kupnem. Wreszcie, coraz cz\u0119\u015bciej pojawia si\u0119 w\u015br\u00f3d Klient\u00f3w ? odbiorc\u00f3w dokumentacji oczekiwanie dokumentacji \u0142atwo dost\u0119pnej ? Klient nie chce dzi\u015b czeka\u0107, a\u017c r\u00f3wnocze\u015bnie z maszyn\u0105 na palecie dostarczy mu si\u0119 opas\u0142y tom rysunk\u00f3w i tekstu. Woli wej\u015b\u0107 na stron\u0119 internetow\u0105 firmy i \u015bci\u0105gn\u0105\u0107 plik PDF na sw\u00f3j komputer, albo przej\u015b\u0107 przez interaktywny program szkoleniowy.<\/p>\n

\nCo chyba oczywiste, oczekiwanie wewn\u0119trzne, a wi\u0119c ?nadawc\u00f3w? informacji zawartej w dokumentacji technicznej, s\u0105 po cz\u0119\u015bci to\u017csame z oczekiwaniami Klient\u00f3w, ale po cz\u0119\u015bci zdecydowanie si\u0119 od nich r\u00f3\u017cni\u0105, zw\u0142aszcza bior\u0105c pod uwag\u0119 s\u0142ynne powiedzenie, \u017ce punkt widzenia zale\u017cy od punktu siedzenia.<\/p>\n

\nJakiej dokumentacji chce Zarz\u0105d producenta? Zarz\u0105d oczekuje optymalnych nak\u0142ad\u00f3w i koszt\u00f3w zwi\u0105zanych z tworzeniem dokumentacji, jasnych i sprecyzowanych zasad jej tworzenia, dobrze zdefiniowanych zada\u0144 os\u00f3b odpowiedzialnych za jej tworzenie, precyzyjnie okre\u015blonych praw i obowi\u0105zk\u00f3w poszczeg\u00f3lnych uczestnik\u00f3w procesu ? w tym prawa do wprowadzania zmian i ich zatwierdzania,.<\/p>\n

\nInna optyka rz\u0105dzi oczekiwaniami dzia\u0142u marketingu i sprzeda\u017cy ? dla nich najwa\u017cniejsze s\u0105 szybki dost\u0119p do zawsze aktualnych informacji, odpowiedni format dokumentacji, lub jej cz\u0119\u015bci, umo\u017cliwiaj\u0105cy szybkie stworzenie prezentacji na spotkanie z Klientem, ulotki reklamowej, prezentacji w Internecie czy materia\u0142u na szkolenie, pe\u0142na wieloj\u0119zyczno\u015b\u0107 ? je\u015bli Klienci firmy wymagaj\u0105 dokumentacji w swoim j\u0119zyku ojczystym.<\/p>\n

\nTym wszystkim oczekiwaniom sprosta\u0107 musi autor, czy zesp\u00f3\u0142 autor\u00f3w i redaktor\u00f3w ? dzia\u0142 dokumentacji technicznej. Aby tego dokona\u0107 musi zatroszczy\u0107 si\u0119 o jasny podzia\u0142 obowi\u0105zk\u00f3w w ramach ca\u0142ej firmy i zespo\u0142u, o \u0142atwo\u015b\u0107 gromadzenia danych potrzebnych do stworzenia dokumentacji (wielo\u015b\u0107 format\u00f3w elektronicznych r\u00f3\u017cnych sk\u0142adnik\u00f3w dokumentacji jest tu kluczowym problemem do rozwi\u0105zania), o prosty spos\u00f3b generowania rozmaitych form dokumentacji w oparciu o te same \u017ar\u00f3d\u0142a, ograniczenie dodatkowych czynno\u015bci koniecznych do wygenerowania ostatecznego pakietu informacji, mo\u017cliwo\u015b\u0107 dynamicznej wsp\u00f3\u0142pracy w ramach organizacji rozproszonej (je\u015bli w przygotowaniu jednego dokumentu bierze udzia\u0142 geograficznie rozproszony zesp\u00f3\u0142 redaktor\u00f3w, albo na przyk\u0142ad t\u0142umaczy) i oczywi\u015bcie optymalne koszty przygotowania dokumentacji.<\/p>\n

\nPodane powy\u017cej zagadnienia zapewne nie wyczerpuj\u0105 definicji dobrej dokumentacji technicznej, wydaje si\u0119 jednak, \u017ce dotykaj\u0105 przynajmniej podstawowych problem\u00f3w zwi\u0105zanych z tworzeniem i zarz\u0105dzaniem cyklem \u017cycia informacji o produkcie w przedsi\u0119biorstwie.<\/p>\n

\nDlatego niew\u0105tpliwie warto sobie zada\u0107 pytanie, czy wszystkie powy\u017csze oczekiwania czy kryteria udaje si\u0119 w naszym przedsi\u0119biorstwie wype\u0142ni\u0107.<\/p>\n

\nW dzisiejszej rzeczywisto\u015bci to jednak nie wystarczy. Trzeba dzia\u0142a\u0107. Mo\u017cliwe jest wiele scenariuszy. Z do\u015bwiadczenia wiadomo, \u017ce w przypadku stwierdzenia problem\u00f3w jako\u015bciowych czy wydajno\u015bciowych (w tym przypadku w zakresie tworzenia dokumentacji i zarz\u0105dzania ni\u0105) pierwszym naturalnym odruchem jest my\u015bl o zwi\u0119kszeniu zespo\u0142u, dodatkowych etatach, mo\u017ce wi\u0119kszych zarobkach. Oczywi\u015bcie mo\u017cna tak zrobi\u0107.<\/p>\n

\nWcze\u015bniej warto jednak albo przeanalizowa\u0107 procesy zwi\u0105zane z zarz\u0105dzaniem dokumentacj\u0105,\u00a0 albo zasi\u0119gn\u0105\u0107 opinii zewn\u0119trznych specjalist\u00f3w, wyspecjalizowanych firm doradczych i outsourcingowych zajmuj\u0105cych si\u0119 problemem od lat. Po gruntowanej analizie proces\u00f3w biznesowych i pr\u00f3bie ich zoptymalizowania, zaproponuj\u0105 oni zapewne dob\u00f3r narz\u0119dzia informatycznego pozwalaj\u0105cego na systemowe zaspokojenie potrzeb organizacji w zakresie redagowania i zarz\u0105dzania dokumentacj\u0105 techniczn\u0105, lub zaproponuj\u0105 oddanie procesu do realizacji firmie zewn\u0119trznej (czego nie nale\u017cy myli\u0107 z odebraniem zaj\u0119cia w\u0142asnym autorom dokumentacji; dzieje si\u0119 zwykle wr\u0119cz przeciwnie).<\/p>\n

\nJedn\u0105 z ich sugestii mo\u017ce by\u0107 wdro\u017cenie systemu redakcyjnego klasy CMS (Content Management System). Nie chodzi tu jednak o popularne tak\u017ce w Polsce systemy do zarz\u0105dzania zawarto\u015bci\u0105 stron internetowych czy portali, ale o specjalistyczne, dedykowane dla przemys\u0142u profesjonalne narz\u0119dzie redakcyjne.<\/p>\n

\nJak funkcjonuje takie rozwi\u0105zanie?<\/strong><\/p>\n

\nPodstawowymi cechami charakteryzuj\u0105cymi systemy redakcyjne dedykowane do tworzenia dokumentacji technicznej s\u0105 z jednej strony modularyzacja tre\u015bci, a z drugiej oddzielenie zawarto\u015bci od formatu, w jakim jest przechowywana.<\/p>\n

\nM\u00f3wi\u0105c w du\u017cym uproszczeniu, tekst instrukcji podzielony zostaje na najmniejsze mo\u017cliwe modu\u0142y informacji (na przyk\u0142ad opis konkretnej czynno\u015bci ?Pod\u0142\u0105czanie urz\u0105dzenia do pr\u0105du? albo ostrze\u017cenie o niebezpiecze\u0144stwie), dzi\u0119ki czemu osi\u0105gni\u0119ta zostaje jedna z podstawowych korzy\u015bci opisywanego rozwi\u0105zania, jak\u0105 jest mo\u017cliwo\u015b\u0107 wielokrotnego u\u017cycia tego samego modu\u0142u tre\u015bci. Nie ma ju\u017c potrzeby pisania ka\u017cdej dokumentacji od nowa, albo stosowania obarczonego b\u0142\u0119dami i cz\u0119sto niemo\u017cliwego technicznie ?przeklejania? informacji z jednego dokumentu do drugiego. Raz sporz\u0105dzona tre\u015b\u0107 staje si\u0119 dorobkiem mo\u017cliwym do ponownego u\u017cycia. Co wi\u0119cej, ka\u017cda zmiana modu\u0142u automatycznie pojawia si\u0119 we wszystkich dokumentach, w kt\u00f3rych modu\u0142 jest wykorzystywany. Nie trzeba chyba rzekonywa\u0107 o rozmiarach oszcz\u0119dno\u015bci, jakie takie rozwi\u0105zanie mo\u017ce przynie\u015b\u0107<\/p>\n

\nModu\u0142y tre\u015bci s\u0105 przechowywane w odpowiedniej, wsp\u00f3lnej dla wszystkich dokument\u00f3w bazie danych w formacie ?zrozumia\u0142ym? dla wszystkich mo\u017cliwych program\u00f3w DTP, edytor\u00f3w czy program\u00f3w do obr\u00f3bki stron internetowych. Dodatkowo posiadaj\u0105 one swoje opisy, tzw. metadane, pozwalaj\u0105ce je sklasyfikowa\u0107, a p\u00f3\u017aniej wyszukiwa\u0107 w bazie w razie potrzeby ich u\u017cycia. Jak wspomniano powy\u017cej, instrukcja obs\u0142ugi opracowywana jest na og\u00f3\u0142 na podstawie wielu danych \u017ar\u00f3d\u0142owych, pochodz\u0105cych z r\u00f3\u017cnych etap\u00f3w prac nad produktem, r\u00f3\u017cnych dzia\u0142\u00f3w przedsi\u0119biorstwa, i co najtrudniejsze, z r\u00f3\u017cnych \u015brodowisk informatycznych ? cho\u0107by rysunk\u00f3w typu AutoCad, plik\u00f3w graficznych program\u00f3w do sk\u0142adu i tekst\u00f3w pisanych w r\u00f3\u017cnych edytorach tekst\u00f3w. W opisanym rozwi\u0105zaniu r\u00f3\u017cnorodno\u015b\u0107 format\u00f3w nie ma znaczenia. Ponadto zapewniona jest sp\u00f3jno\u015b\u0107 informacji, gdy\u017c raz przygotowane modu\u0142y tre\u015bci s\u0105 wykorzystywane we wszystkich dokumentach.<\/p>\n

\nObok tych dwu podstawowych korzy\u015bci rozwi\u0105zanie typu CMS zapewnia tak\u017ce sp\u00f3jno\u015b\u0107 tre\u015bci. Zapewnie niejednemu przysz\u0142emu Klientowi przysz\u0142o do g\u0142owy pytanie, dlaczego o tych samych elementach urz\u0105dzenia spo\u015br\u00f3d gamy produkt\u00f3w jednego dostawcy, instrukcja za ka\u017cdym razem m\u00f3wi innymi s\u0142owami, lub na co\u015b innego zwraca uwag\u0119. Zapewne w r\u00f3\u017cnych fazach prac nad instrukcjami, pracowa\u0142y nad ni\u0105 r\u00f3\u017cne osoby, kt\u00f3re wzajemnie nie informowa\u0142y si\u0119 o swoich czynno\u015bciach. W opisywanym rozwi\u0105zaniu sytuacja taka nie jest mo\u017cliwa, gdy\u017c wszyscy uczestnicy procesu tworzenia instrukcji pracuj\u0105 na wsp\u00f3lnym materiale i automatycznie zapami\u0119tuj\u0105 najbardziej aktualne, ostateczne wersje swej pracy.<\/p>\n

\nUzyskana zostaje tak\u017ce pe\u0142na transparentno\u015b\u0107 procesu dla wszystkich jego uczestnik\u00f3w z mo\u017cliwo\u015bci\u0105 przypisania r\u00f3l i powi\u0105zanych z nimi uprawnie\u0144, niezale\u017cnie od zlokalizowania poszczeg\u00f3lnych os\u00f3b czy dzia\u0142\u00f3w. Dzi\u0119ki temu mo\u017cliwe jest zdefiniowanie klarownego przep\u0142ywu zada\u0144 (workflow), w kt\u00f3rym ka\u017cdy zna swoje zadania, swoj\u0105 rol\u0119 i kolejno\u015b\u0107 wykonywania poszczeg\u00f3lnych czynno\u015bci.<\/p>\n

\nRozwi\u0105zania typu CMS s\u0105 zwykle w pe\u0142ni integrowalne z narz\u0119dziami IT wspieraj\u0105cymi procesy t\u0142umaczenia. Aspekt ten nie jest dla wielu przedsi\u0119biorstw, zw\u0142aszcza produkuj\u0105cych na eksport, zagadnieniem obcym. Wa\u017cne jest, aby to, co tak dobrze staramy si\u0119 opracowa\u0107 w j\u0119zyku orygina\u0142u, by\u0142o r\u00f3wnie dobre w j\u0119zyku odbiorc\u00f3w. Dzi\u0119ki opisywanemu rozwi\u0105zaniu wersje w j\u0119zykach obcych s\u0105 poddane dok\u0142adnie tak samo sp\u00f3jnemu i kontrolowanemu procesowi, jak teksty oryginalne.<\/p>\n

\nW powy\u017cszym materiale podj\u0119to pr\u00f3b\u0119 usystematyzowania wyznacznik\u00f3w prawid\u0142owego zarz\u0105dzania informacj\u0105 o produkcie w przedsi\u0119biorstwie. Przedstawiono tak\u017ce og\u00f3lnie korzy\u015bci p\u0142yn\u0105ce z wdro\u017cenia w firmie specjalistycznych narz\u0119dzi informatycznyc wspomagaj\u0105cych redagowanie dokumentacji technicznej.<\/p>\n

\nSi\u0142\u0105 rzeczy s\u0105 to informacje stosunkowo og\u00f3lne. Aby oceni\u0107 faktyczn\u0105 przydatno\u015b\u0107 takich system\u00f3w, ale i dostrzec zagro\u017cenia \u00a0nimi zwi\u0105zane konieczne b\u0119dzie przedstawienie i rzeczowa analiza konkretnych przypadk\u00f3w ich zastosowania. B\u0119dzie ona tematem kolejnych artyku\u0142\u00f3w na \u0142amach Design News. Ju\u017c teraz zapraszamy do lektury.<\/p>\n

Autor: SZYMON MALECKI<\/i><\/p>\n","protected":false},"excerpt":{"rendered":"

Podstawowym zapisem przepis\u00f3w Unii Europejskiej zawartych w tzw. dyrektywach nowego podej\u015bcia, w tym w szczeg\u00f3lno\u015bci Dyrektywy Maszynowej jest stwierdzenie, \u017ce dokumentacja techniczna urz\u0105dzenia jest jego cz\u0119\u015bci\u0105 sk\u0142adow\u0105, tak\u0105 sam\u0105 jak \u017car\u00f3wka w reflektorze albo wa\u0142 korbowy w silniku spalinowym. Powodem wadliwego funkcjonowania urz\u0105dzenia (np. reflektora) mo\u017ce by\u0107 spalona \u017car\u00f3wka, ale mo\u017cliwe jest te\u017c, \u017ce istniej\u0105ca dokumentacja techniczna w niewystarczaj\u0105cy spos\u00f3b opisuje niezb\u0119dne warunki, wymagane dla poprawnej pracy urz\u0105dzenia<\/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-2024","post","type-post","status-publish","format-standard","tag-igus"],"_links":{"self":[{"href":"https:\/\/www.designnews.pl\/wp-json\/wp\/v2\/posts\/2024","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=2024"}],"version-history":[{"count":0,"href":"https:\/\/www.designnews.pl\/wp-json\/wp\/v2\/posts\/2024\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.designnews.pl\/wp-json\/wp\/v2\/media?parent=2024"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.designnews.pl\/wp-json\/wp\/v2\/categories?post=2024"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.designnews.pl\/wp-json\/wp\/v2\/tags?post=2024"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}