Potrzebuję nowej instrukcji lub dokumentacji
Masz wiedzę, źródła i ekspertów, ale nie masz jeszcze spójnego dokumentu, struktury oraz źródła do dalszych aktualizacji.
Zobacz tworzenie instrukcji i dokumentacjiDokumenty
Instrukcje obsługi i dokumentacja techniczna
Pomagam uporządkować, stworzyć, zaktualizować lub przygotować do kolejnych wersji językowych instrukcje obsługi i dokumentację techniczną. Punkt startu zależy od tego, czy masz materiały i ekspertów, gotowy dokument, czy tylko PDF.
Punkt startu
Wybierz punkt startu dla instrukcji lub dokumentacji.
Aktualizuję albo lokalizuję istniejącą instrukcję
Masz istniejący dokument, zmiany produktu albo tłumaczenia i potrzebujesz kolejnej wersji. Ostateczny punkt startu zależy od zakresu zmian, nie każda aktualizacja jest lokalizacją.
Zobacz lokalizację instrukcji i dokumentacjiMam tylko PDF
Brakuje edytowalnego źródła albo obecny materiał nie nadaje się do dalszej aktualizacji. Najpierw trzeba ocenić, co da się odtworzyć; PDF nie jest automatycznie konwertowany.
Zobacz rekonstrukcję PDFInstrukcja obsługi jest jednym z rezultatów szerszego procesu dokumentacyjnego.
Zakres może obejmować instrukcję obsługi, instrukcję użytkowania, podręcznik użytkownika, instrukcję instalacji, montażu, uruchomienia, konserwacji lub serwisową. W prostszym zakresie może to być także skrócona instrukcja, czyli quick start guide.
Są to przykłady rodzajów dokumentów przygotowywanych zależnie od produktu, urządzenia, maszyny, systemu, oprogramowania, procesu albo innego rozwiązania technicznego. Nie tworzą osobnych usług ani nie opisują konkretnych realizacji.
- instrukcja obsługi i instrukcja użytkowania
- podręcznik użytkownika
- instrukcja instalacji
- instrukcja montażu
- instrukcja uruchomienia
- instrukcja konserwacji
- instrukcja serwisowa
- skrócona instrukcja (quick start guide)
- dokumentacja produktu, systemu, oprogramowania lub procesu
Pierwsza ocena
Dokument gotowy do dalszej pracy nie kończy się na pojedynczym eksporcie.
- edycję i aktualizację bez przypadkowego rozjazdu struktury
- wersjonowanie oraz lokalizację kolejnych wersji językowych
- publikację w uzgodnionym kanale i utrzymanie struktury
- ponowne wykorzystanie elementów, gdy pozwala na to model dokumentu
- materiały źródłowe, ekspertów i decyzje potrzebne do dalszej pracy
Odpowiedzialności
Instrukcja jest wspólnym procesem produkcyjnym, nie zastępstwem wiedzy specjalistycznej.
ePaper DTP / realizacja techniczna
Analizuje materiały, projektuje strukturę i architekturę dokumentu, przygotowuje szablon, system stylów, skład, tabele, schematy, ilustracje, źródło, wersjonowanie, techniczny QA oraz eksport.
Ekspert klienta
Zatwierdza sposób działania produktu, kolejność czynności, dane techniczne, ostrzeżenia, zagrożenia, środki bezpieczeństwa, procedury instalacji, użytkowania, konserwacji i serwisu, kompletność merytoryczną oraz dokument.
Lingwista
Odpowiada za tłumaczenie, terminologię, kontrolę językową i akceptację wersji językowej.
Autor techniczny
Uczestniczy wyłącznie wtedy, gdy jego zakres został odrębnie uzgodniony; nie zakładam automatycznie pełnego autorstwa specjalistycznego.
Dokument warto zaprojektować tak, aby kolejne wersje nie zaczynały się od chaosu.
Struktura rozdziałów, style, numeracja, podpisy i tabele decydują o tym, czy następna aktualizacja będzie kontrolowaną zmianą, czy ręcznym poprawianiem wielu stron. Uporządkowane źródło ogranicza ryzyko rozjazdu wersji.
Przygotowanie do przyszłych języków nie oznacza automatycznego tłumaczenia. Oznacza natomiast przewidywalne style, miejsce na zmianę długości tekstu, edytowalne elementy graficzne oraz jasny podział odpowiedzialności przy kolejnych wersjach.
Proces kwalifikacji
Proces kwalifikacji instrukcji i dokumentacji.
01
Rodzaj dokumentu i odbiorca
Określamy, czy chodzi o instrukcję, inną dokumentację techniczną oraz kto będzie z niej korzystać.
02
Materiały i eksperci
Oceniamy źródła, dostępne dane, ilustracje, tabele oraz osoby zatwierdzające merytorykę i język.
03
Wybór punktu startu
Rozdzielamy tworzenie nowego dokumentu, aktualizację albo lokalizację istniejącego oraz rekonstrukcję źródła z PDF.
04
Próbka lub zakres
Dla złożonego materiału określamy kolejność działań, ryzyka, format źródłowy i rezultat przed pełną produkcją.
05
Właściwy proces
Projekt przechodzi do procesu tworzenia, lokalizacji albo rekonstrukcji odpowiedniego dla materiału.
06
Techniczny QA i publikacja
Kontrola obejmuje uzgodnione elementy techniczne, kompletność oraz przygotowanie plików do wybranego kanału publikacji.
Powiązane usługi
Kolejny krok zależy od źródła, skali dokumentacji i planu publikacji, także w FrameMakerze, XML i DITA.
Tworzenie instrukcji i dokumentacji
Tworzenie instrukcji obsługi i dokumentacji technicznej z materiałów oraz wiedzy ekspertów klienta.
Lokalizacja instrukcji i dokumentacji
Techniczna lokalizacja istniejących instrukcji obsługi i dokumentacji z dostarczonymi tłumaczeniami.
Rekonstrukcja z PDF
Oceniam PDF i dostępne zasoby, a następnie odtwarzam dokument w uzgodnionym formacie do aktualizacji, tłumaczenia lub ponownej publikacji.
FrameMaker, XML i DITA
Projektuję i rozwijam dokumentację FrameMaker oraz XML/DITA: strukturę informacji, migracje, publikację wielokanałową i przygotowanie do lokalizacji.
Odpowiedzi
FAQ: instrukcje obsługi i dokumentacja techniczna
Pytania, które pomagają ustalić punkt startu, zakres i odpowiedzialność.
Zacznij od tego, czy masz już istniejący dokument, tylko PDF, rozproszone materiały, czy gotowe tłumaczenia. Nowy dokument prowadzi do tworzenia instrukcji, gotowy dokument z tłumaczeniami do lokalizacji, a brak źródła do oceny lub rekonstrukcji PDF. Przy dużej dokumentacji, wielu wersjach i publikacji wielokanałowej warto sprawdzić też FrameMaker, XML lub DITA.
Tworzenie oznacza zbudowanie dokumentu z materiałów, danych i wiedzy ekspertów klienta. Aktualizacja dotyczy zmiany istniejącej treści, procedur, danych lub ilustracji. Lokalizacja dotyczy istniejącego dokumentu i dostarczonych tłumaczeń, które trzeba technicznie przygotować w kolejnych wersjach językowych.
Tak, ale najpierw trzeba ocenić, co jest aktualnym źródłem, co tylko materiałem referencyjnym, a co wymaga zatwierdzenia przez eksperta. PDF może wystarczyć do wstępnej oceny, ale nie daje tych samych możliwości co plik otwarty. Jeżeli źródło nie istnieje, właściwą ścieżką może być najpierw rekonstrukcja dokumentu.
Tak, jeśli źródło zostanie zbudowane z myślą o strukturze, stylach, numeracji, grafikach i wersjonowaniu. To nie oznacza automatycznego tłumaczenia, ale ułatwia późniejszą lokalizację i aktualizacje. Warto ustalić ten cel już na początku, bo wpływa na narzędzie i sposób przygotowania dokumentu.
Dane techniczne, procedury, ostrzeżenia, środki bezpieczeństwa i kompletność merytoryczną zatwierdza ekspert klienta. ePaper DTP odpowiada za uzgodnioną strukturę, skład, wersjonowanie, techniczny QA i eksport. Jeżeli projekt obejmuje wersje językowe, tłumaczenie i terminologię zatwierdza właściwa osoba językowa.
Warto je rozważyć przy dużej, regularnie aktualizowanej dokumentacji, reuse treści, wielu wariantach, publikacji wielokanałowej albo potrzebie strukturalnego źródła. Nie każdy dokument wymaga takiego modelu. Decyzja powinna wynikać z celu, skali, źródeł i sposobu utrzymania dokumentacji.
Nie. Przygotowanie dokumentu nie jest certyfikacją, analizą prawną, formalną oceną zgodności, potwierdzeniem spełnienia norm ani zatwierdzeniem bezpieczeństwa produktu. Dokument może być opracowywany na podstawie materiałów, wymagań i wytycznych zatwierdzonych przez klienta.
Ustal właściwy punkt startu.
Opisz materiał, podaj jego format, wklej link do próbki i wskaż oczekiwany rezultat. Na tej podstawie można wybrać tworzenie, aktualizację, lokalizację albo ocenę PDF.