Nawyki przy pisaniu DTR-ki

Na wstępie witam szanowne grono inżynierów :slightly_smiling_face:

A teraz do rzeczy. W pracy zlecono mi przygotowanie instrukcji DTR, a dokładniej opisanie każdego sensownego screenu hmi jakie może przydać w ostatecznej wersji dokumentacji dla klienta.
W moim zakładzie pracy przyjęło się ogólnie opisywanie tylko podstawowych ekranów panelu hmi. Osobiście mam duże chęci zawarcia w dokumentacji wszystkich screenow jakie operatorzy lub UR może napotkać.
Tutaj chciałbym grzecznie zapytać jakich praktyk nabierać aby użytkownicy opisywanych przeze mnie maszyn mogli w prosty sposób zrozumieć działanie maszyny i obsługę czytając moja dtrke.

1lajk

Polecam przewertować instrukcje do oprogramowania i sprzętu od firmy Allen Bradley (Rockwell Automation) ich instrukcje są zrobione w taki sposób, że każdy głupi to zrozumie i przeklika, jak dla mnie wzór :slight_smile:

1lajk

Zobacz sobie 15 punkt w tym artykule, co prawda podpowiedzi dotyczą systemu SCADA ale do HMI też jest ok.
https://zestapro.pl/2019/07/18/15-najczesciej-popelnianych-bledow-wizualizacji-scada-i-hmi/

Ja swoje DTRki wykonywałem w podobny sposób. Na początku rysowałem strukturę menu z informacją który ekran jest na jakiej stronie DTR. Następnie wyjaśniłem nawigację po ekranach po czym odpisywałem poszczególne ekrany, alarmy i funkcje.

Na końcu można dać spis rozwiązań do “typowych problemów”.

Instrukcja ma pomagać operatorom więc powinna w pewnym stopniu wyczerpać temat wszystkich opcji.

Unikałbym skrótów myślowych a raczej pisał w możliwie najprostszym języku nawet powtarzając niektóre opisy na kolejnych stronach aby operator nie musiał szukać informacji i skakać po stronach lub umieszczał odnośniki do dodatkowych informacji np. (alarmy zostały opisane na stronie 7)

W praktyce operatorzy raczej nie czytają instrukcji od pierwszej strony do ostatniej tylko robią szybki przegląd, znajdują ekran z którym chcą się zapoznać, bo np. na nim wyświetla się błąd. Dlatego nawigacja i odnośniki w samej DTR też są ważne.

Dziękuje Panom za podpowiedzi.

1lajk

Może uściślijmy - nie mylmy Dokumentacji Techniczno Ruchowej z Podręcznikiem Użytkownika [User Manual], która jest zaledwie tylko mikro częścią DTR.
Tak jak koledzy pisali wcześniej, najlepiej wziąć istniejący już podręczniki i wzorować się na jego strukturze - spis treści jako wzór konspekt.

1lajk

Odgrzebię stary temat.

  • Zasady sporządzania instrukcji przede wszystkim opisuje dyrektywa maszynowa 2006/42/WE w p. 1.7.3 załącznika I.

  • Punkt 6.4.5 normy PN-EN ISO 12100 zharmonizowanej z dyrektywą maszynową rozwija wymaganą treść instrukcji opisaną w dyrektywie i podaje wskazówki, jak powinna wyglądać forma przedstawienia treści instrukcji.

  • Jeśli maszyna została zbudowana z wykorzystaniem norm typu B i/lub C, to projektant zawsze powinien spojrzeć do tych norm, bo bardzo często stawiały one dodatkowe wymagania co do treści instrukcji i oznaczeń na samej maszynie.

  • Można też było korzystać z normy PN-EN 82079-1 “Przygotowanie instrukcji użytkowania - Opracowanie struktury, zawartość i sposób prezentacji - Część 1: Zasady ogólne i wymagania szczegółowe”. Norma dotyczy wymagań na temat przygotowywania wszelkich typów instrukcji, nie tylko do maszyn.

  • Od niedawna na PKN do kupienia jest norma PN-EN ISO 20607:2019-08 “Bezpieczeństwo maszyn - Instrukcja obsługi - Ogólne zasady opracowywania”, która jeszcze nie jest zharmonizowana z MD, ale wkrótce będzie i będzie obowiązywała. Norma w trochę bardziej szczegółowy podchodzi np. co do przedstawienia formy zawartości treści.

A tak poza tym, jeśli ktoś potrzebuje gruntownej wiedzy na temat instrukcji, to firma CertPartner organizuje szkolenia z tego zakresu. Mam nadzieję, że moderatorzy nie potraktują tego jako kryptoreklamę - forum służy do dzielenia się wiedzą, a szkolenie to kawał dobrej wiedzy.

1lajk