Czy twoja dokumentacja powstaje na ostatnią chwilę?

Dokumentacja jest elementem produktu wymaganym przez prawo i liczne rozporządzenia. Regulacje prawne danego kraju definiują jej niezbędne części, a nawet określają pożądaną strukturę.

„Kiedy dochodzi do wypadku, zawsze odpowiedzialny jest za to przede wszystkim zarząd firmy, a jako pierwsza sprawdzana jest dokumentacja”, wskazuje specjalista ds. dokumentacji technicznej, Jukka Toimela, który pracuje w biurze Etteplanu w Tampere.

Wymagania dotyczące jakości dokumentacji technicznej są na wysokim poziomie. Do tego dochodzi potrzeba opracowywania dokumentacji dla różnych wersji produktowych i językowych, zarządzania nimi i utrzymywania.

„W wielu firmach dokumentacja techniczna jest jednak wciąż uważana za zło konieczne. Często zostaje stworzona na ostatnią chwilę. Projektanci i menedżerowie opracowują dokumentację bez należytej dokładności, w przerwie pomiędzy swoimi pozostałymi obowiązkami”, dziwi się Jukka Toimela.

„To oczywiste, że Dokumentacja wymaga zaangażowanych specjalistów zdolnych obsłużyć podmiot, a także znających regulacje i wymagania oraz wykorzystujących skuteczne metody. Tworzenie wysokiej jakości dokumentów jest najskuteczniejsze, gdy opiera się na ścisłej współpracy wyspecjalizowanych edytorów dokumentów/autorów dokumentów z projektantami sprzętu.” podkreśla Jukka Toimela.

Dobrze przygotowany dokument służy czytelnikowi

„Najważniejszy aspekt wiąże się z bezpieczeństwem. Jak zamontować, używać i naprawiać produkt bez szkód dla zdrowia i środowiska? Jak uniknąć uszkodzenia produktu? Aspekty bezpieczeństwa opisane są w trzech krokach. Jakie jest ryzyko, co ono oznacza i jak można go uniknąć” - wylicza Jukka Toimela.

„Dokumenty muszą być zwięzłe, jasne i dobrze zilustrowane. Muszą prezentować przedmioty w poprawnej kolejności i mieć zrozumiałą strukturę. Służą mechanikom, użytkownikom, serwisantom i wszystkim innym grupom docelowym”, mówi Jukka Toimela. Zdjęcie po prawej ukazuje narzędzie HyperSTE, które sprawdza treść pod kątem czytelności.

Redaktor zawsze musi mieć na uwadze użytkownika. Dokument powinien odpowiadać na pytania, które użytkownik może zadać. Nie ma tu natomiast miejsca na odpowiedzi na specjalistyczne, szczegółowe pytania zadawane przez kolegę inżyniera, chyba że jest przewidywanym odbiorcą dokumentacji.

„Nie można przecenić roli zdjęć i obrazów. Czytelna grafika to niezbędny element dokumentu wysokiej jakości” - podkreśla Jukka Toimela.

Porady typu „Dobrze wiedzieć” informują czytelnika o dobrych praktykach i metodach. Pamiętaj, by zawrzeć je w dokumentacji. Uwagi i porady dotyczące prawidłowego korzystania z produktu są bezcenne. Instrukcja użytkowania opisuje, w jaki sposób w pełni wykorzystywać funkcje i cechy urządzenia.

HyperSTE - narzędzie sprawdzające czytelność tekstu

Wersje kontrolowane

„Podstawowa reguła dokumentu strukturyzowanego jest prosta: jest on podzielony na moduły, których wersjami (produktowymi i językowymi) zarządza się osobno”, podsumowuje Jukka Toimela. Obrazek po lewej stronie ukazuje system zarządzania treścią HyperDoc.

Moduł odpowiada na pojedyncze pytanie lub opisuje zadanie, na przykład to, w jaki sposób włączyć silnik. Poprawka naniesiona w zadaniu dotyczy tylko jednego modułu. Zmiana i prawidłowa informacja pojawia się automatycznie we wszystkich publikacjach, gdzie ten moduł był wykorzystywany. Zwykle ma on długość 1 - 1,5 strony.

Utrzymywanie dokumentacji staje się zdecydowanie łatwiejsze. Poprawka naniesiona w zadaniu dotyczy tylko jednego modułu. Zmiana i prawidłowa informacja automatycznie nanosi się w sposób kaskadowy do wszystkich publikacji, gdzie ten moduł był wykorzystywany.

Ustrukturyzowane systemy dokumentacji automatycznie tworzą szablony różnych wersji językowych. Zdjęcie i powiązany tekst pokazują się na tej samej stronie, nawet jeśli długość treści nie jest jednakowa między wersjami. Dzięki tej funkcji oszczędzamy wiele godzin pracy.

Zmniejszenie kosztów tłumaczenia

„W niektórych firmach projektanci o różnym stopniu znajomości języka angielskiego tworzą fragmenty dokumentacji, używając przy tym niejednolitej terminologii. Tłumacze stają wówczas przed niemal niewykonalnym zadaniem. Rośnie koszt opracowania wersji językowych przy jednoczesnym spadku ich jakości” - mówi Jukka Toimela.

Także ten problem da się rozwiązać dzięki współpracy ze specjalistami ds. dokumentacji, korzystających z wydajnych metod i narzędzi.

Moduł pojawiający się w kilku publikacjach ustrukturyzowanego systemu trzeba przetłumaczyć tylko za pierwszym razem. Również zarządzanie tłumaczeniami kolejnych wersji produktowych także staje się skuteczniejsze.

Tłumaczenia w języku angielskim i chińskim przygotowywane są dla wersji A produktu. Po wprowadzeniu na rynek wersji B i C produktu, moduł języka angielskiego zostaje zaktualizowany. Chińska wersja językowa nie musi być jednak zmieniana, jeśli na tamtejszym rynku dostępna jest jedynie wersja A.

Materiały przechowywane są w pamięci tłumaczeniowej. Pokazuje ona, które zdania już zostały przetłumaczone, które wymagają jedynie drobnych poprawek, a które muszą być przetłumaczone w całości. Każde zdanie trzeba przetłumaczyć tylko raz.

Drzwi otwarte na przyszłość

„Skutecznie wykorzystujemy potencjał digitalizacji. Jeśli publikowana informacja pojawia się w interfejsie urządzenia inteligentnego, nie ma potrzeby tworzenia instrukcji papierowych. Systemy mogą być także umieszczane na przykład w środowiskach rozszerzonej rzeczywistości” - chwali się Jukka Toimela.