Wstęp
W 2001 roku Międzynarodowa Komisja Elektrotechniczna (IEC) opublikowała pierwszą normę z zakresu projektowania instrukcji użytkowych IEC 62079, Preparation of instructions – Structuring, content and presentation. Norma ta miała na celu ustalenie pierwszych powszechnie obowiązujących wymagań i zaleceń dotyczących opracowania przez wytwórców produktów instrukcji użytkowania na potrzeby użytkowników. IEC 62079:2001 została wycofana i zastąpiona przez IEC 82079-1:2012, wprowadzoną do zbioru Norm Europejskich jako EN 82079 – 1:2012, Preparation of instructions for use – Structuring, content and presentation – Part 1: General principles and detailed requirements, wprowadzającą. W 2013 r. Polski Komitet Normalizacyjny (PKN) przyjął EN 82079-1:2012 do zbioru Polskich Norm, a 3 września 2014 r. opublikował normę w języku polskim (jako PN-EN 82079-1:2013-05 Przygotowanie instrukcji użytkowania ‒ Opracowanie struktury, zawartość i sposób prezentacji ‒Część 1: Zasady ogólne i wymagania szczegółowe). Dla ułatwienia, stosuje nazwę EN 82079-1:2012 w dalszej części artykułu.
W EN 82079-1:2012 określono zasady ogólne i wymagania szczegółowe dotyczące projektowania i redagowania wszelkich typów instrukcji użytkowania oraz podstawowe zasady zarządzania dokumentacją techniczną i zapewnienia bezpieczeństwa użytkownikom produktów. Miała zastosowanie zarówno w przypadku niewielkich i typowych produktów (np. AGD) jak i wielkogabarytowych lub wysoce złożonych produktów (np. uzbrojenie, elektrownie, linie przemysłowe, gotowe do użytku fabryki lub instalacje technologiczne). Głównym celem EN 82079-1:2012 było stworzenie ram dla procesu tworzenia instrukcji użytkowania i określenie wymagań i sposobów właściwego zarządzania dokumentacją techniczną pod kątem przyszłego procesu lokalizacji na potrzeby globalizacji.
Z założenia EN 82079-1:2012 miała być pierwszą z cyklu europejskich norm dokumentacyjnych, przeznaczonych dla wszystkich podmiotów zajmujących się m.in. przygotowywaniem instrukcji użytkowania, niezależnie od tego, czy są to dostawcy, autorzy dokumentacji technicznej i ilustracji do niej, projektanci oprogramowania i rozwiązań technicznych, tłumacze, redaktorzy techniczny, terminolodzy, koordynatorzy projektów, menedżerowie produktów i procesów, czy też inne osoby biorące udział w tworzeniu dokumentacji, instrukcji użytkowania, opisów produktów i usług powiązanych.
EN 82079-1:2012 była istotna również ze względu na to, że określała kompetencje dla nowego zawodu na rynku polskim – autora dokumentacji technicznej. Ponadto jako tzw. norma horyzontalna wpisywała się dobrze w schemat zharmonizowanego systemu norm i legislacji UE, obejmujący dokumentację i komunikację techniczną, procesy przemysłowe, bezpieczeństwa i zarządzania ryzykiem, co miało również określone implikacje prawne i praktyczne. Zapisy te mogły być uznawane za wymagania normatywne z punktu widzenia urzędów, producentów i konsumentów oraz kluczowe inicjatywy UE – NLF (m.in. system oznakowania CE, nadzór rynku pod kątem bezpieczeństwa produktów i dostęp do informacji RAPEX, harmonizacja norm technicznych itp.).
Najnowsza wersja IEC/IEEE 82079-1:2019 Preparation of information for use (instructions for use) of products -- Part 1: Principles and general requirements została wydana wspólnie przez Międzynarodową Organizację Normalizacyjną (ISO), IEC i Instytut Inżynierów Elektryków i Elektroników (IEEE) (współpracujące w ramach wspólnej grupy roboczej JWG 16 Preparation of instructions for use utworzonej w 2015 roku). Zgodnie z deklaracjami, norma ta ma na celu normalizację ogólnych zasad i wymagań dotyczących projektowania i opracowania wszelkich informacji użytkowania (zwanych również instrukcjami użytkowania), które mogą być niezbędne lub pomocne dla użytkowników rożnych rodzajów produktów, począwszy od towarów konsumenckich, poprzez wysoce skomplikowane instalacje, maszyny przemysłowe, a skończywszy na elektrowniach czy osiedlach. Dla ułatwienia, stosuję nazwę IEC 82079-1:2019 w dalszej części artykułu.
Cel i zakres normy IEC 82079-1:2019
IEC 82079-1:2019 jest wprowadzana jako projekt Normy Europejskiej prEN IEC/IEEE 82079-1:2019 i zastąpi EN 82079-1:2012. Głównym celem IEC 82079-1:2019 jest opracowanie ram i wymagań dla procesu tworzenia już nie instrukcji użytkowania, tylko informacji użytkowania. Jest też nadal oznaczana jako pierwsza z serii, chociaż wchłonęła niektóre elementy zaplanowanych wcześniej kolejnych norm z tej serii (np. w zakresie dotyczącym zakładów produkcyjnych i systemów powiązanych oraz instrukcji produktów do samodzielnego składania (montażu), których dalsze opracowanie zostało zaniechane.
We wstępie do normy informacje zostały klasyfikowane według następujących typów:
- Informacje pojęciowe (pojęcia, wskazówki odnośnie bezpieczeństwa, inne),
- Informacje instruktażowe (procedury, komunikaty ostrzegawcze, inne),
- Informacje referencyjne (usuwanie usterek, harmonogram konserwacji, inne).
Zgodnie z zakresem normy, informacje użytkowania są: niezbędne do bezpiecznego użytkowania produktu; pomocne w efektywnym i skutecznym użytkowaniu produktu; i często spełniają zobowiązania rynkowe, prawne i regulacyjne. Informacje użytkowania produktów odnoszą się do ich faz cyklu życia, takich jak: transport, montaż, instalacja, uruchomienie, eksploatacja, monitorowanie, usuwanie usterek, konserwacja, naprawy, likwidacja i utylizacja, a także do odpowiednich zadań wykonywanych przez osoby wykwalifikowane i niewykwalifikowane. Zgodnie z deklaracją, IEC 82079-1:2019 określa ogólne ramy dla potencjalnych kolejnych części i ma zastosowanie do informacji użytkowania, które mogą być wykorzystywane zarówno w formie elektronicznej, jak i drukowanej. Norma jest przeznaczona dla wszystkich osób odpowiedzialnych za koncepcję, tworzenie, utrzymanie, tłumaczenie, lokalizację, integrację treści, produkcję, ocenę, pozyskiwanie i dostarczanie informacji użytkowania. Celem normy jest zapewnienie tym osobom wspólnej podstawy dla opracowania odpowiedniej jakości informacji użytkowania produktów. Norma z założenia powinna być stosowana i przywoływana w innych normach dotyczących konkretnych produktów, w tym w normach określających zawartość informacji użytkowania dla takich produktów, na przykład seria PN-EN 60335 (Elektryczny sprzęt do użytku domowego i podobnego; opracowywane równolegle z IEC), PN-EN ISO 20607:2019-08 (Bezpieczeństwo maszyn – Instrukcja obsługi – Ogólne zasady opracowywania) oraz ISO/IEC 26514:2008 (Systemy i oprogramowanie). Ma ona stanowić podstawę do opracowania specyficznych wymagań dotyczących produktów dla odbiorców docelowych lub informacji o produkcie. Jako norma horyzontalna jest przede wszystkim przeznaczona do stosowania przez komitety techniczne przy opracowywaniu norm zgodnie z zasadami określonymi w Przewodniku IEC 108.
Istotne zmiany techniczne pomiędzy IEC 82079-1:2019 a EN 82079-1:2012
Zgodnie z przedmową, nowa wersja normy z 2019 roku zawiera następujące istotne zmiany techniczne w stosunku do poprzedniego wersji:
- Struktura dokumentu została przeorganizowana w celu ułatwienia stosowania normy i wyszukiwania informacji. Tam, gdzie było to możliwe, język został uproszczony.
- Wprowadzono pojęcie informacji użytkowania jako terminu ogólnego. Instrukcja użytkowania jest synonimem informacji użytkowania. Instrukcje krok po kroku funkcjonują teraz jako podzbiór informacji użytkowania.
- Rozdział 5 (Zasady) – [wcześniej Rozdział 4] została przeredagowana i skupia się teraz na celu informacji użytkowania, jakości informacji i procesie zarządzania informacjami.
- Proces przygotowania informacji użytkowania został zintegrowany z częścią normatywną i potraktowany kompleksowo.
- W części normatywnej opisano empiryczne metody oceny informacji użytkowania.
- Kompetencje zawodowe potrzebne do przygotowania/opracowania informacji użytkowania zostały omówione bardziej szczegółowo.
- Uwzględniono dodatkowe aspekty ogólnych wymagań dotyczących informacji użytkowania do wykorzystania w złożonych systemach.
- Zwrócono uwagę na instrukcje dotyczące wyrobów do samodzielnego montażu.
- Wprowadzono załącznik informacyjny zawierający wskazówki dotyczące spełniania określonych wymagań.
W rzeczywistości, różnice między EN 82079-1:2012 i IEC 82079-1:2019 są znacznie bardziej podstawowe i nie wszystkie są pozytywne.
Jakich informacji dotyczy IEC/IEEE 82079-1:2019, jakie wymagania zostały zmienione i co jest istotne?
Po zmianie tytułu normy, złagodzeniu wielu wymogów oraz bardziej ogólnym podejściu do instrukcji użytkowania, celem jaki postawiono był to zapewne opracowanie normy, zarządzania informacją inteligentną i treściami cyfrowymi w ogóle. Niestety cel ten nie do końca został osiągnięty. Koncepcja przejścia z poziomu instrukcji użytkowania (obsługi) i dokumentacji na wyższy poziom zarzadzania informacją, jest jak najbardziej uzasadniona. Jednak taka zmiana perspektywy powinna być jasno określona we wstępie i odzwierciedlona w zapisach normy. Niestety, tak się nie stało. Co więcej, terminologia i język normy są raczej niespójne. Brakuje też odniesień do niektórych kluczowych terminów i innych istotnych norm, wymagań, dobrych praktyk z zakresu zarządzania informacją inteligentną, treścią cyfrową i niektórych uwarunkowań internacjonalizacji.
Norma zasadniczo klasyfikuje informacje jako informacje pojęciowe, instruktażowe i referencyjne. Nie podjęto próby stworzenia jakiegokolwiek schematu mapowania informacji, który wskazywałby na ich interakcje i rozwój produktu informacyjnego, a przykłady wyjściowe nie wydają się wynikać z żadnego kompleksowego podejścia modelowego, ani nie stanowią praktycznego odniesienia dla twórców informacji.
W globalnej cyfryzacji i inteligentnej informacji, zwykle przywołuje się na myśl następuje zagadnienia:
- informacja jako treść zorganizowana do przechowywania, wyszukiwania i ponownego wykorzystania;
- strategie wykorzystywania informacji do opracowywania treści i zarządzania nimi jako aktywem korporacyjnym;
- zarządzanie inteligentną informacją wymaga wydajnych procesów, zasobów ludzkich i technologii;
- skalowalne podejścia do zarządzania treścią;
- zoptymalizowane procesy autoryzacji i zarządzania treścią;
- zautomatyzowane procesy zarzadzania informacją, które wspierają ponowne wykorzystanie różnych komponentów treści;
- generowanie spersonalizowanych treści, które służą różnym celom, mogą być rozpowszechniane i dostarczane za pośrednictwem wielu platform/kanałów do różnych odbiorców docelowych;
- konieczność wykorzystania metadanych i algorytmów indeksowania;
- analiza wpływu digitalizacji i różnych mediów społecznościowych na przetwarzanie i rozpowszechnianie informacji, itp.
W IEC 82079-1:2019 opisano strategie i proces zarządzania informacją (Rozdziały 5 i 6), kompetencji zawodowych (osób zaangażowanych) (Rozdział 10), mediów i formatów (Rozdział 9), struktury i dostarczania informacji (Rozdział 8). W tym sensie obejmuje ona niektóre z punktów, które wymieniono powyżej.
W odniesieniu do informacji wyróżnia się następujące cztery grupy procesów:
- Analiza i planowanie informacji
- Projektowanie i rozwój (w tym recenzja, edycja i testowanie)
- Produkcja i dystrybucja
- Utrzymanie (w tym utrzymanie i doskonalenie)
Norma zawiera zalecenia dotyczące hierarchicznego ustrukturyzowania informacji w taki sposób, aby tylko istotne informacje były dostarczane do odbiorców docelowych (Rozdział 8). Nie zawarto tam szczególnych wymagań czy odniesień do konkretnych rozwiązań.
Jeśli chodzi o cyfryzację informacji, w IEC 82079-1:2019 podano mniej wymagań szczegółowych niż w poprzedniej wersji. Wymagania dotyczące mediów i formatu (Rozdział 9) są też mniej restrykcyjne niż poprzednio. Niektóre z tych wymagań dostosowano do potrzeb odbiorców docelowych (np. tekst drukowany nie zawsze jest wymagany, nie każdy użytkownik potrzebuje dokładnej instrukcji użytkowania itp.). Natomiast nie podano w normie szczegółowych wytycznych tylko raczej ogólne uwagi typu, że media powinny zapewniać łatwy i stały dostęp do informacji w celu ich wykorzystania i być odpowiednio dobrane.
Rozdział 10 dotyczy zasobów ludzkich. Zgodnie z normą, za tworzenie informacji użytkowania powinny odpowiadać osoby kompetentne. Wskazanie rzeczywistych wymagań jest zawarte w definicji terminu (3.3). Niemiej, w IEC 82079-1:2019 wiele mówi się ogólnie o kompetencjach. Nie podaje się natomiast konkretnych wymagań dotyczących kwalifikacji.
Na przykład norma ISO 17100:2015 Translation services – Requirements for translation services (PN-EN ISO 17100:2015-06 Usługi tłumaczeniowe – Wymagania dotyczące świadczenia usług tłumaczeniowych) przywołana została tylko w kontekście procesu tłumaczenia (w nocie). Kompetencje tłumacza w IEC 82079-1:2019 są znacznie niższe niż minimalne wymagania kompetencyjne ISO 17100, natomiast minimalne kwalifikacje tłumacza lub wymagania kwalifikacyjne innych osób uczestniczących w procesie nie są uwzględnione. Zrezygnowano z kluczowego wymagania ISO 17100 dotyczącego obowiązkowej weryfikacji (tzw. „zasada czterech oczu”), które było uwzględnione w EN 82079-1:2012. Nie odniesiono się też do wymagań określonych w ISO 17100 w kontekście procesu tłumaczenia i kompetencji.
Podsumowanie
IEC 82079:2019 obniża niektóre z wymagań zawartych w poprzedniej wersji i nie odnosi się do innych norm, które dotyczą różnych aspektów procesu opracowywania lub przetwarzania informacji/treści i kompetencji osób za to odpowiedzialnych (szczególnie zastanawia ewidentny brak odpowiedniego odniesienia do ISO 17100 w zakresie kompetencji tłumaczy, weryfikatorów i redaktorów). Norma jest obecnie dość obszerna (130 stronic) i zawiera wiele ogólnych zaleceń, ale stosunkowo mało rzeczywistych wymagań.
IEC 82079:2019 była pomyślana jako ogólna norma dotycząca informacji inteligentnych i faktycznie odnosi się do niektórych zagadnień zarządzania informacją inteligentną i technologią cyfrową (np. formatów). W założeniu norma miała jednak również służyć jako podstawa certyfikacji – potwierdzenie zgodności z jej wymaganiami w zakresie zarówno generowania produktów informacyjnych, jak również procesu zarządzania informacją. W rzeczywistości norma oferuje głownie zalecenia dotyczące kompetencji zasobów ludzkich, etapów i kontroli procesów. Niektóre kluczowe pojęcia i dobre praktyki w zakresie zarządzania informacją leżą u podstaw normy IEC 82079:2019 lub zostały wprost w niej ujęte i jest to cenne źródło informacji dla osób z branży. W praktyce normy zawierające głównie zalecenia (zamiast wymagań) są po prostu niecertyfikowalne.
EN 82079-1:2012, jako tzw. norma horyzontalna odwołująca się do wielu pojęć i programów UE dobrze wpisywała się w schemat zharmonizowanego systemu norm i legislacji UE, obejmujący dokumentację i komunikację techniczną, procesy przemysłowe, bezpieczeństwa i zarządzania ryzykiem, co ma również określone implikacje prawne i systemowe. Stanowiła zalecenie normatywne z punktu widzenia urzędów, producentów i konsumentów oraz wpisywała się w kluczowe programy i inicjatywy UE –NLF (m.in. system oznakowania CE, nadzór rynku pod kątem bezpieczeństwa produktów i dostęp do informacji RAPEX, harmonizacja norm technicznych itp.), ERK (Europejska Rama Kwalifikacji) itd.
IEC 82079:2019 została opracowana nie tylko na podstawie EN 82079-1:2012 ale również kilku innych dokumentów, głównie jednak przez osoby nie będące rodzimymi użytkownikami języka angielskiego lub jego odmiany brytyjskiej. W normie ujęto wiec podstawowe zagadnienia i pojęcia, ale czasem są one ukryte pod innymi pojęciami, w ogólnikowych opisach lub dziwnych sformułowaniach (np. „some aspects have been added to the general requirements for information for use for complex systems of systems”) lub stosowane są określenia nietypowe zamiast typowych dla branży (np.”human factors consultants” zamiast “HR specialists”), niektóre z kluczowych terminów nie są w ogóle przywołane (np. metadata, digitalized, revision, review, proofreading – jako weryfikacja techniczna składu). Brak jest konsekwentnego stosowania konwencji językowych, specjalistycznej/znormalizowanej terminologii (np. użyto „competency” w znaczeniu i zamiast „competence”, „basic competency” zamiast „minimum competence”, „localization and terminology experts” zamiast „localization specialists”, ”PMs” i „terminologists” itp.. Na podstawie powyższych przykładów i analizy można odnieść wrażenie, że redaktorzy tej normy niestety nie stosowali się do własnych zaleceń ani obowiązujących zasad redakcyjnych i nie odnieśli się do zasobów terminologicznych ISO (które normalizują w dużej mierze terminologię branżową) przy opracowywaniu tej obszernej „informacji użytkowania”, jaką niewątpliwie jest IEC 82079:2019 oraz wątpliwe jest by ta wersja dobrze wpisywała się w schemat zharmonizowanego systemu norm i legislacji UE, który preferuje mierzalne wymagania nad amerykańskim podejściem prefereującym zalecenia.
|
EN 82079-1:2012
|
IEC 82079-1:2019
|
Tytuł EN:
|
Preparation of instructions for use – structuring, content and presentation – Part 1: General principles and detailed requirements
|
Preparation of information for use (instructions for use) of products –Part 1: Principles and general requirements
|
Tytuł PL |
Przygotowanie instrukcji użytkowania ‒ Opracowanie struktury, zawartość i sposób prezentacji ‒ Część 1: Zasady ogólne i wymagania szczegółowe. [przyjęty nr referencyjny PN-EN 82079-1:2013-05]
|
Przygotowanie informacji użytkowania (instrukcji użytkowania) produktów ‒ Część 1: Zasady i wymagania ogólne.[roboczy tytuł i nr referencyjny PN-EN 82079-1]
|
Data publikacji: |
08.2012
|
05.2019
|
Data publikacji wersji polskiej: |
10.2013
[jako PN-EN 82079-1:2013-05]
|
2021
[planowana]
|
Wydanie: |
1 |
1 |
Status: |
Wycofana |
Opublikowana |
Liczba stron: |
107 |
130 |
Komitet Techniczny ISO odpowiedzialny: |
ISO/TC 10 Technical product documentation
|
ISO/TC 10/SC 1 Basic conventions (JWG 16 Preparation of instructions for use – IEC, IEEE, ISO)
|
Komitet Techniczny PKN odpowiedzialny: |
Komitet Techniczny nr 256
|
Komitet Techniczny nr 256
|
ICS: |
ICS: 01.110 Technical product documentation
[Dokumentacja techniczna produktu]
|
ICS: 01.110 Technical product documentation
[Dokumentacja techniczna produktu]
|
Inne źródła:
https://www.iso.org/standard/71620.html
http://www.maart.com/en/blog/new-iecieee-82079-12019
https://sklep.pkn.pl/pn-en-82079-1-2013-05p.html
http://www.maart.com/blog/norma-dokumentacyjna-pn-en-82079-1-przygotowanie-instrukcji-uzytkowania
https://standards.ieee.org/standard/82079-1-2019.html