Przejdź do treści

Dokumenty

Lokalizacja instrukcji obsługi i dokumentacji technicznej

Gotowe tłumaczenie nie jest jeszcze gotową instrukcją. Przygotowuję kolejne wersje językowe istniejących instrukcji obsługi i dokumentacji technicznej z zachowaniem struktury, tabel, ostrzeżeń, grafik oraz możliwości dalszej aktualizacji.

Wersja bazowa dokumentu i wersja lokalizowana z dopasowanym układem.

Punkt wejścia

Masz istniejącą instrukcję i gotowe tłumaczenia, ale potrzebujesz kompletnych wersji językowych.

  • Istnieje instrukcja obsługi albo dokumentacja techniczna oraz plik źródłowy lub co najmniej materiał referencyjny.
  • Tłumaczenia dostarcza klient, agencja albo wskazany lingwista, wraz z językami docelowymi i osobą odpowiedzialną za akceptację językową.
  • Przed rozpoczęciem ustalane są format dostawy, odpowiedzialność za dane techniczne i ostrzeżenia oraz sposób dalszego wersjonowania.

Lokalizacja dotyczy istniejących dokumentów technicznych, nie tylko jednego rodzaju instrukcji.

Zakres może obejmować instrukcje obsługi i użytkowania, podręczniki użytkownika, instrukcje instalacji, montażu, uruchomienia, konserwacji i serwisowe, a także skrócone instrukcje, dokumentację systemu, oprogramowania, procesu oraz inne istniejące dokumenty techniczne.

Są to przykładowe typy materiałów, a nie osobne usługi ani deklaracje konkretnych realizacji. Punkt wyjścia pozostaje ten sam: istniejący dokument, dostarczone tłumaczenia i potrzeba przygotowania wersji do dalszej pracy lub publikacji.

  • instrukcja obsługi
  • instrukcja użytkowania
  • podręcznik użytkownika
  • instrukcja instalacji
  • instrukcja montażu
  • instrukcja uruchomienia
  • instrukcja konserwacji
  • instrukcja serwisowa
  • skrócona instrukcja
  • dokumentacja systemu, oprogramowania lub procesu

Tłumaczenie staje się instrukcją po przygotowaniu technicznym.

Tłumaczenie obejmuje przełożenie treści, terminologię, poprawność językową, styl i akceptację lingwistyczną. Za ten zakres odpowiada klient, agencja, lingwista albo inna osoba wskazana przez klienta.

Lokalizacja techniczna obejmuje przygotowanie dokumentu tak, aby dostarczone tłumaczenie działało w strukturze, układzie i uzgodnionych formatach. Techniczny QA nie potwierdza poprawności tłumaczenia ani terminologii. Nie zmieniam samodzielnie treści, ostrzeżeń ani procedur: problematyczne fragmenty są zgłaszane do decyzji.

Integracja tłumaczenia

  • import albo wprowadzenie dostarczonego tłumaczenia
  • obsługa ekspansji tekstu i przepełnień
  • wersjonowanie plików oraz oznaczenie regionów

Struktura dokumentu

  • numeracja, odsyłacze, spisy i indeksy
  • tabele, ostrzeżenia, podpisy i tekst w grafikach
  • style, fonty, grafiki oraz uzgodniony szablon

Kontrola i eksport

  • techniczny QA układu, kompletności i zasobów
  • eksport do uzgodnionych kanałów
  • zgłaszanie pytań zamiast samodzielnej zmiany treści

Zakres projektu

Lokalizacja nie jest nazwą dla każdej zmiany w dokumencie.

Lokalizacja gotowej instrukcji

Sytuacja
Zatwierdzona wersja źródłowa i dostarczone tłumaczenie.
Właściwy punkt startu
Integracja tłumaczenia, skład, wersjonowanie, QA techniczne i eksport.

Aktualizacja treści źródłowej

Sytuacja
Zmienił się produkt, parametr, procedura, ilustracja albo ostrzeżenie.
Właściwy punkt startu
Przed przygotowaniem wersji językowych potrzebna jest zatwierdzona nowa treść klienta.

Zmiana szablonu lub narzędzia

Sytuacja
Dokument ma przejść do nowego układu, szablonu albo środowiska.
Właściwy punkt startu
To dodatkowy zakres, ustalany osobno, a nie automatyczny element każdej lokalizacji.

Brak pliku źródłowego

Sytuacja
Dostępny jest tylko PDF lub inny materiał referencyjny.
Właściwy punkt startu
Najpierw potrzebna jest ocena rekonstrukcji źródła; PDF nie oznacza automatycznej konwersji.

Przy braku źródła właściwą ścieżką jest rekonstrukcja dokumentu z PDF, dopiero potem lokalizacja możliwa w uzgodnionym zakresie.

Źródła, tłumaczenia, zasoby i wymagania dostawy trzeba rozdzielić przed rozpoczęciem składu.

Plik źródłowy, tłumaczenia, fonty i wymagania publikacji pełnią różne role. Ich kompletność wpływa na sposób oceny, próbkę ryzykownych stron i możliwość dalszej aktualizacji dokumentu.

Dla źródeł `.fm`, `.book`, MIF, XML/DITA i structured applications szczegółowy zakres specjalistycznej lokalizacji opisuje strona lokalizacji FrameMaker. Tutaj pozostaje ogólny proces dla instrukcji i dokumentacji technicznej.

Dokument źródłowy

  • InDesign, IDML, FrameMaker, BOOK, MIF, Word, XML, DITA, DITAMAP albo inny uzgodniony format
  • PDF referencyjny do oceny wyglądu i kompletności
  • źródło musi pozwalać na zakres uzgodnionych zmian

Tłumaczenia

  • zatwierdzone pliki, języki i wersje regionalne
  • glosariusz, terminologia i instrukcje językowe
  • teksty pozostające bez tłumaczenia oraz kontakt do pytań językowych

Zasoby

  • fonty, grafiki, edytowalne ilustracje, linki i logotypy
  • szablony oraz pliki źródłowe wykresów i tabel
  • wymagania dotyczące eksportów

Wymagania dostawy

  • języki, regiony, formaty i kanał publikacji
  • druk albo publikacja cyfrowa, pliki otwarte i pakowanie
  • nazewnictwo wersji, kolejność dostaw i oczekiwany rezultat

Po tłumaczeniu zmienia się nie tylko tekst, ale także zachowanie dokumentu.

Ekspansja albo skrócenie tekstu może zmienić paginację, wysokość tabel, szerokość kolumn, łamanie, położenie ostrzeżeń i relację tekstu z ilustracją. Przepełnienia, błędna numeracja kroków, nieaktualne odsyłacze, spisy lub indeksy nie są problemami językowymi, ale wpływają na użyteczność wersji.

Techniczna kontrola obejmuje także elementy pozostawione w języku źródłowym, tekst w grafikach, fonty bez potrzebnych znaków, niekompletne wersje i niejednoznaczne oznaczenie regionów. Automatyczne skracanie tłumaczenia nie jest rozwiązaniem: każda zmiana treści wymaga akceptacji właściwej osoby.

Dłuższy tekst zwężający tabelę w lokalizowanej wersji dokumentu.

Języki europejskie, azjatyckie i RTL wymagają oceny konkretnego źródła oraz próbki.

Dla języków europejskich kontrola obejmuje ekspansję tekstu, znaki diakrytyczne, podziały wyrazów, fonty oraz, gdy dotyczą dokumentu, formaty liczb, dat i jednostek. Wersje mogą powstawać także w kierunkach bez języka polskiego jako pośredniego.

W językach azjatyckich sprawdzane są obsługa znaków przez font, łamanie tekstu, interpunkcja, tabele i dopasowanie layoutu. RTL wymaga oceny kierunku pisma, kolejności elementów, wyrównania, tabel, numeracji, grafik, fontów i odsyłaczy. W obu sytuacjach potrzebna jest próbka oraz kontrola lingwisty znającego dany język; ePaper DTP nie deklaruje tej kontroli po swojej stronie.

Fonty, grafiki i ilustracje mogą wyznaczać realny zakres lokalizacji.

Font musi obsługiwać znaki języka docelowego, a jego zamiana może wpłynąć na układ. Licencja fontu może ograniczać przekazanie plików. Tekst w grafice wymaga edytowalnego źródła; bez niego element może wymagać odtworzenia jako dodatkowego zakresu.

Ilustracja musi zachować zgodność z zatwierdzoną treścią, a podpis, numer i odsyłacz do niej powinny pozostać spójne. Grafika nie powinna przypadkowo pozostać w języku źródłowym. Usługa nie obejmuje domyślnie zaawansowanego modelowania CAD ani tworzenia specjalistycznej ilustracji technicznej.

Podział odpowiedzialności

Wersja językowa wymaga oddzielnych decyzji technicznych, językowych i merytorycznych.

ePaper DTP / realizacja techniczna

Analiza źródła, integracja dostarczonych tłumaczeń, układ, style, tabele, grafiki, fonty, numeracja, odsyłacze, spisy, wersjonowanie, techniczny QA, eksport i raportowanie ograniczeń.

Klient albo ekspert klienta

Poprawność danych technicznych, aktualność procedur, ostrzeżenia, środki bezpieczeństwa, zatwierdzenie zmian merytorycznych oraz potwierdzenie kompletności instrukcji.

Lingwista, klient albo agencja

Tłumaczenie, terminologia, poprawność językowa, akceptacja skrótów i zmian treści, kontrola wersji językowej oraz akceptacja systemu pisma i RTL.

Osoba zatwierdzająca wymogi formalne

Wymagania prawne, normy, wytyczne branżowe, formalna ocena zgodności i obowiązkowe elementy dokumentu. Nie są one domyślną kontrolą ePaper DTP.

Proces lokalizacji instrukcji

Od oceny źródła do wersji przygotowanej do kolejnej aktualizacji.

  1. 01

    Analiza dokumentu źródłowego

    Materiał wejściowy
    Plik źródłowy albo materiał referencyjny.
    Działanie
    Ocena struktury, stylów, tabel, grafik i możliwości wersjonowania.
    Decyzja klienta
    Potwierdzenie celu oraz dostępnych źródeł.
    Rezultat etapu
    Wstępny zakres i lista ograniczeń.
    Ryzyko do rozstrzygnięcia
    PDF nie zapewnia takiego samego workflow jak plik otwarty.
  2. 02

    Inwentaryzacja wersji i języków

    Materiał wejściowy
    Lista języków, regionów i istniejących wersji.
    Działanie
    Ustalenie nazewnictwa, priorytetów oraz kompletności pakietu.
    Decyzja klienta
    Wskazanie wersji docelowych i kolejności dostaw.
    Rezultat etapu
    Plan wersjonowania.
    Ryzyko do rozstrzygnięcia
    Niejednoznaczne regiony mogą prowadzić do błędnej wersji.
  3. 03

    Analiza tłumaczeń i instrukcji językowych

    Materiał wejściowy
    Dostarczone tłumaczenia, glosariusz i instrukcje językowe.
    Działanie
    Kontrola kompletności materiałów oraz oznaczenie pytań do lingwisty.
    Decyzja klienta
    Wskazanie osoby akceptującej język.
    Rezultat etapu
    Zestaw plików gotowych do integracji.
    Ryzyko do rozstrzygnięcia
    Techniczny QA nie zatwierdza terminologii.
  4. 04

    Kontrola fontów, grafik i zasobów

    Materiał wejściowy
    Fonty, linki, ilustracje i pliki graficzne.
    Działanie
    Sprawdzenie znaków, licencji, edytowalności i braków.
    Decyzja klienta
    Akceptacja zamienników lub dodatkowego odtworzenia.
    Rezultat etapu
    Lista zasobów i ograniczeń.
    Ryzyko do rozstrzygnięcia
    Brak źródeł grafiki może ograniczyć zmianę tekstu.
  5. 05

    Próbka stron o największym ryzyku

    Materiał wejściowy
    Reprezentatywne tabele, ostrzeżenia, grafiki i gęste strony.
    Działanie
    Próba układu, łamania i dopasowania wersji językowej.
    Decyzja klienta
    Akceptacja rozwiązania albo decyzja o zmianie zakresu.
    Rezultat etapu
    Zatwierdzony kierunek produkcyjny.
    Ryzyko do rozstrzygnięcia
    Skrócenie treści wymaga decyzji właściwej osoby.
  6. 06

    Integracja tłumaczeń i skład

    Materiał wejściowy
    Zatwierdzone pliki tłumaczeń oraz próbka.
    Działanie
    Wprowadzenie treści, dopasowanie układu i wersjonowanie.
    Decyzja klienta
    Odpowiedzi na zgłoszone pytania.
    Rezultat etapu
    Robocze wersje językowe.
    Ryzyko do rozstrzygnięcia
    Ekspansja tekstu może zmienić paginację i tabele.
  7. 07

    Aktualizacja elementów dokumentu

    Materiał wejściowy
    Robocze wersje oraz zasoby.
    Działanie
    Kontrola tabel, grafik, podpisów, odsyłaczy, spisów i indeksów.
    Decyzja klienta
    Akceptacja zmian wymagających decyzji merytorycznej lub językowej.
    Rezultat etapu
    Spójna struktura dokumentu.
    Ryzyko do rozstrzygnięcia
    Nieaktualne elementy mogą pozostać w języku źródłowym.
  8. 08

    Zgłoszenie pytań i decyzji

    Materiał wejściowy
    Lista niejednoznaczności z produkcji.
    Działanie
    Przekazanie pytań do klienta albo lingwisty.
    Decyzja klienta
    Akceptacja terminologii, treści, ostrzeżeń i skrótów.
    Rezultat etapu
    Zatwierdzone decyzje do wdrożenia.
    Ryzyko do rozstrzygnięcia
    Nie zastępuję decyzji eksperta ani lingwisty.
  9. 09

    Techniczny QA

    Materiał wejściowy
    Wersje po integracji i decyzjach.
    Działanie
    Kontrola kompletności, układu, struktury, zasobów i eksportu.
    Decyzja klienta
    Potwierdzenie zakresu kontroli technicznej.
    Rezultat etapu
    Lista usterek technicznych albo raport QA.
    Ryzyko do rozstrzygnięcia
    QA nie jest korektą językową, walidacją danych ani certyfikacją.
  10. 10

    Kontrola lingwistyczna

    Materiał wejściowy
    Wersja po technicznej integracji.
    Działanie
    Wskazana osoba sprawdza język, terminologię i RTL, gdy dotyczy.
    Decyzja klienta
    Akceptacja wersji językowej.
    Rezultat etapu
    Informacja o zatwierdzeniu albo poprawkach.
    Ryzyko do rozstrzygnięcia
    Zakres tej kontroli nie należy domyślnie do realizacji technicznej.
  11. 11

    Eksport i dostawa

    Materiał wejściowy
    Zatwierdzone wersje i wymagania kanału.
    Działanie
    Eksport, pakowanie, nazewnictwo i kontrola kompletności dostawy.
    Decyzja klienta
    Akceptacja formatów oraz plików otwartych, jeśli są objęte zakresem.
    Rezultat etapu
    Uzgodnione wersje do druku, publikacji albo dalszej pracy.
    Ryzyko do rozstrzygnięcia
    PDF/X jest stosowany tylko przy znanych wymaganiach.
  12. 12

    Dokumentacja ograniczeń i kolejnej aktualizacji

    Materiał wejściowy
    Dostarczone pliki oraz lista decyzji.
    Działanie
    Zebranie ograniczeń, pytań i zasad dalszego wersjonowania.
    Decyzja klienta
    Potwierdzenie sposobu utrzymania kolejnych wersji.
    Rezultat etapu
    Dokument możliwy do dalszej aktualizacji w uzgodnionym zakresie.
    Ryzyko do rozstrzygnięcia
    Przekazanie źródeł zależy od zakresu i licencji zasobów.

Kompletność

  • strony, sekcje, języki, segmenty i załączniki
  • elementy pozostawione w języku źródłowym
  • kompletność grafik i wersji

Układ

  • przepełnienia, łamanie, paginacja, tabele i podpisy
  • ostrzeżenia, listy, numeracja oraz wdowy i sieroty, gdy dotyczą standardu
  • czytelność po zmianie długości tekstu

Struktura

  • style, odsyłacze, spisy, indeksy, zakładki i hiperłącza
  • zmienne i conditional text, gdy dotyczą
  • XML/DITA tylko w zakresie specjalistycznego źródła

Zasoby i eksport

  • fonty, linki, grafiki, tekst w grafikach i rozdzielczość
  • przestrzeń barwna, gdy dotyczy druku
  • parametry PDF, pakowanie, nazewnictwo i kanał publikacji

Techniczny QA nie zastępuje kontroli językowej ani formalnej.

Kontrola techniczna nie jest korektą językową, kontrolą terminologii, walidacją danych technicznych, certyfikacją ani oceną zgodności. Jej celem jest wykrycie problemów w dokumencie, układzie, strukturze, zasobach i eksporcie.

Gdy problem dotyczy treści, ostrzeżenia, procedury, terminu albo wersji językowej, jest zgłaszany do klienta, eksperta albo lingwisty wskazanego dla projektu.

Rezultat

  • kompletna technicznie wersja językowa
  • zachowana struktura i uporządkowane wersjonowanie
  • dokument gotowy do uzgodnionej publikacji

Dalsza praca

  • źródło możliwe do aktualizacji w uzgodnionym zakresie
  • lista ograniczeń i pytań
  • raport technicznego QA, jeśli obejmuje go zakres

Możliwe formaty

  • INDD, IDML, FrameMaker, BOOK, MIF i Word
  • XML, DITA, PDF, PDF/X albo pakiet źródłowy
  • inne uzgodnione eksporty

Pliki otwarte

  • tylko gdy obejmuje je uzgodniony zakres
  • z uwzględnieniem licencji fontów, grafik, szablonów i zasobów
  • bez automatycznej obietnicy przekazania wszystkich źródeł
Odpowiedzi

FAQ: lokalizacja instrukcji obsługi i dokumentacji technicznej

Pytania o tłumaczenia, źródła, języki, odpowiedzialność i pliki końcowe.

Masz instrukcję, źródła i gotowe tłumaczenia?

Opisz rodzaj instrukcji, format źródłowy, język źródłowy i docelowe, liczbę stron albo dokumentów, dostępność tłumaczeń, fontów i grafik, oczekiwany rezultat, termin oraz link do próbki.

Opisz zakres lokalizacji instrukcji