Sektor Nowej Energii: Najlepsze praktyki w zakresie dokumentacji technicznej

Informacje branżowe · 15 grudnia 2001 r
Informacje branżoweLokalizacjaGlobalna EkspansjaDokumentacja techniczna

Artykuł

15 grudnia 2001 r

W przypadku akumulatorów i magazynowania energii najczęstszym błędem w dokumentacji nie jest błędne tłumaczenie. Są to wersje językowe oddalające się od siebie w miarę wyprzedzania linii produktów.

Jedna wiarygodna specyfikacja na linię produktów

Produkty do akumulatorów i pamięci masowych szybko się zmieniają, a linie produktów szybko się rozszerzają, a najczęstszą przyczyną awarii nie jest błędne tłumaczenie, ale rozbieżność wersji językowych. Chińska specyfikacja przeszła trzy poprawki, a niemiecka wciąż znajduje się na pierwszej; klient używający niewłaściwego pliku jest drobnostką, błąd instalacji z tego powodu jest incydentem.

Rozwiązaniem jest zachowanie jednej wiarygodnej specyfikacji dla każdej linii produktów i wyprowadzenie z niej każdej wersji językowej. Jakakolwiek zmiana jest najpierw wprowadzana u źródła, a następnie wypychana. Wydaje się to oczywiste, jednak pliki większości zespołów są rozproszone w dziesiątkach dokumentów i wiadomości e-mail i nie ma sposobu, aby stwierdzić, który z nich jest wiarygodny.

Pojedyncze źródło nie tylko zapewnia spójność: umożliwia oszacowanie cen lokalizacji. Gdy źródło jest stabilne, obciążenie pracą tłumaczeniową jest przewidywalne. Jeśli źródło zmienia się codziennie, każdy cytat jest fikcyjny.

Powiąż wersję dokumentu z wersją produktu

Pierwsza linia dokumentu powinna określać, której wersji sprzętu i oprogramowania sprzętowego dotyczy. Nowe produkty energetyczne często podlegają rewizji i nawet ten sam model może posiadać różnice parametrów pomiędzy partiami. Klienci montujący nowe urządzenie ze starą instrukcją są częstym źródłem sporów.

Wiążący oznacza, że ​​numer dokumentu zawiera numer wersji produktu, zmiany wpływają na wersję stopniowo i istnieje zasada, zgodnie z którą dokumenty muszą zostać ponownie sprawdzone i ponownie przetłumaczone w przypadku zmiany wersji produktu. Zasadę tę należy ustalić na początku projektu, a nie renegocjować po każdym incydencie.

Trudność wdrożenia ma zazwyczaj charakter organizacyjny – zespół zmieniający produkt i zespół zarządzający dokumentami to często nie te same osoby. Potrzebny jest jakiś mechanizm, aby zmiana produktu automatycznie uruchomiła przegląd dokumentów; oglądanie tego ręcznie nie działa.

Dokumentacja dotycząca bezpieczeństwa to produkt najwyższej klasy

Produkty akumulatorowe niosą ze sobą większe ryzyko bezpieczeństwa niż większość towarów konsumpcyjnych: niestabilność termiczną, przeładowanie, wymagania transportowe i zasady instalacji. Każdy z nich błędnie zapisany może spowodować obrażenia ciała. Dlatego też rozdziały dotyczące bezpieczeństwa, tłumaczenia ostrzeżeń i oświadczenia dotyczące zgodności nie powinny być traktowane na równi z innymi treściami; są to produkty najwyższej klasy, zaplanowane, przeglądane i archiwizowane oddzielnie.

W rzeczywistych projektach ta sekcja jest rutynowo kompresowana, ponieważ rozdziały dotyczące bezpieczeństwa są krótkie i wyglądają prosto. Ich wymagania dotyczące przeglądu są w rzeczywistości najwyższe – tłumaczenie musi być nie tylko poprawne, ale także odpowiadać brzmieniom regulacyjnym rynku docelowego. Oświadczenia ostrzegawcze mają określone sformułowania w kilku jurysdykcjach, a niewielka zmiana w sformułowaniu zmienia znaczenie prawne.

Utwórz oddzielną listę kontrolną dla dokumentacji bezpieczeństwa: każdy język, każdy wymóg regulacyjny, każda wersja, zaznacz jeden po drugim. W razie wypadku ta lista kontrolna będzie Twoim najsilniejszym dowodem.

Przegląd poszczególnych języków: nie pomijaj tej warstwy

Premiery nowych produktów energetycznych zwykle obejmują dużą liczbę języków, więc presja na recenzje jest większa niż w przypadku zwykłego produktu. Recenzenci, którzy rozumieją domenę i język docelowy, wychwytują problemy, które przeoczają zwykli tłumacze i automatyczne weryfikacje — na przykład termin z określonym tłumaczeniem w lokalnym standardzie, format jednostki niezgodny z lokalną konwencją lub zdanie, którego dosłowne tłumaczenie odwraca jego znaczenie.

Gdy możliwości przeglądu są ograniczone, należy nadać priorytet dokumentacji bezpieczeństwa i głównym językom rynku, a resztą zająć się poprzez podział na warstwy w oparciu o ryzyko. Całkowite porzucenie recenzji nie wchodzi w grę: tłumaczenie maszynowe bez kontroli człowieka ostatecznie zakończy się niepowodzeniem w przypadku treści objętych regulacjami.

FangService posiada zasoby do przeglądu domen w odpowiednich językach w celu uzyskania dokumentacji technicznej nowej energii, a pliki dotyczące bezpieczeństwa i zgodności podlegają pierwszorzędnemu procesowi. Podaj typ produktu i rynki docelowe i zacznij od planu klasyfikacji dla jednego dokumentu.

Najtrudniejsza część dokumentacji dotyczącej przechowywania danych: jeden zestaw danych, wielu czytelników

Projekty magazynowania angażują niezwykłą liczbę stron – właściciela, wykonawcę EPC, firmę sieciową, zespół operacyjny, inspektorów przeciwpożarowych. Patrzą na ten sam system z zupełnie innymi priorytetami. Firma sieciowa odczytuje parametry przyłączenia do sieci i ustawienia zabezpieczeń; operacje odczytuje kody usterek i procedury wymiany; właściciel czyta koszty eksploatacji i granice gwarancji. Napisany jako jedna kompleksowa instrukcja techniczna, dokument nie służy żadnemu z nich; napisany tylko dla operacji, firma sieciowa go nie zaakceptuje. Rozwiązaniem jest nakładanie warstw: tabele parametrów tworzą dokument główny, każda rola otrzymuje swój własny krótki przewodnik, numeracja jest spójna, a cały łańcuch jest aktualizowany razem po rewizji.

Synchronizacja wersji to druga pułapka. Aktualizacja oprogramowania sprzętowego BMS, która dodaje i usuwa kody błędów, jeśli zostały zmienione tylko w podręczniku głównym, pozostawia instrukcje dotyczące poszczególnych ról w starszej wersji, a pole kończy się wyszukiwaniem nowego oprogramowania sprzętowego w oparciu o starą tabelę kodów. FangService łączy glosariusze i numery wersji z tymi projektami, obejmuje każdy dokument pochodny objęty zakresem wersji i wydaje stronę podsumowania zmian dla głównych wersji, dzięki czemu zespół operacyjny klienta może bezpośrednio z niego aktualizować materiały szkoleniowe.

Dokumentacja techniczna aktywów decyduje o kosztach trzeciego roku

Dokumentacja dotycząca magazynowania energii ma cechę charakterystyczną: długi cykl życia obejmujący rozwój, dostawę i eksploatację, z wieloma stronami i wieloma wersjami. Projekty, które traktują dokumentację jako jednorazowy produkt, w trzecim roku kończą się jej wielokrotnym przepisywaniem — operacje chcą nowego formatu, klient chce nowego szablonu, nowy rynek chce nowego języka i za każdym razem treść jest wydobywana ze starych plików.

Assetyzacja oznacza projektowanie do ponownego wykorzystania od pierwszego projektu: spójna struktura, niezależne moduły, stabilna numeracja, kontrolowana terminologia, identyfikowalne wersje. Gdy już je wdrożysz, dodanie języka będzie mnożeniem, a dodanie roli połączeniem, a nie przepisywaniem. Czas spędzony na sprzątaniu z przodu zwraca się przy każdym kolejnym użyciu.

FangService dostarcza bazę terminologii, pamięć tłumaczeniową i zasady wersjonowania w ramach projektu, zamiast dostarczać i odchodzić. Klient otrzymuje nie tylko tłumaczenia, ale stale pracujący zasób, który dla małego zespołu często jest wart więcej niż rabat jednostkowy.

Potrzebujesz niestandardowego rozwiązania?

Podaj nam swój scenariusz projektu i wymagania, a my dopasujemy odpowiednie rozwiązanie i przedstawimy wycenę w ciągu 24 godzin.

Uzyskaj bezpłatną wycenę