ePaper DTP / realizacja techniczna
Odpowiada za analizę materiałów, strukturę i architekturę dokumentu, szablon, system stylów, skład, integrację tabel, schematów i ilustracji, przygotowanie źródła, wersjonowanie, techniczny QA oraz eksport.
Dokumenty
Tworzenie instrukcji obsługi i dokumentacji technicznej
Tworzę instrukcje obsługi i dokumentację techniczną na podstawie zatwierdzonych materiałów, wiedzy ekspertów, tabel, schematów i ilustracji klienta. Celem jest uporządkowane źródło, które można aktualizować, lokalizować i przygotować do publikacji.
Punkt wejścia
Masz produkt, wiedzę i ekspertów, ale nie masz jeszcze spójnej instrukcji albo kompletnej dokumentacji.
- produkt, urządzenie, maszyna, system, oprogramowanie, proces albo inne rozwiązanie techniczne wymaga dokumentu dla określonych odbiorców
- wiedza, materiały i decyzje istnieją, ale są rozproszone między ekspertami, plikami i wcześniejszymi wersjami
- potrzebne jest źródło gotowe do akceptacji, aktualizacji, lokalizacji i publikacji
Wiedza i decyzje klienta
- przeznaczenie produktu albo systemu
- odbiorcy dokumentu, scenariusze użycia i kolejność czynności
- procedury, dane techniczne, ostrzeżenia i środki bezpieczeństwa
- wymagania instalacji, konserwacji i serwisu
- osoby odpowiedzialne za zatwierdzenie
Materiały źródłowe
- istniejące instrukcje i fragmenty dokumentacji
- Word, FrameMaker, InDesign, arkusze i prezentacje
- tabele, schematy, zdjęcia, ilustracje i materiały produktowe
- notatki ekspertów oraz szablon marki
Wymagania publikacyjne
- format źródłowy i format końcowy
- druk albo publikacja cyfrowa
- planowane wersje językowe i system aktualizacji
- narzędzie docelowe oraz zakres przekazania plików otwartych
Jakie instrukcje i dokumenty mogą powstać.
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ć skrócona instrukcja, czyli quick start guide.
Przykłady odnoszą się także do dokumentacji systemu, oprogramowania i procesu oraz innej dokumentacji technicznej do druku albo publikacji cyfrowej. Nie są osobnymi usługami, pełnym katalogiem wszystkich dokumentów ani opisem 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, czyli quick start guide
- dokumentacja systemu, oprogramowania lub procesu
Analiza i mapa braków oddzielają materiał gotowy od decyzji, których nie da się podjąć technicznie.
Analiza rozdziela informacje zatwierdzone, materiały referencyjne, treść roboczą, braki, sprzeczności i decyzje wymagające eksperta. Pozwala także wskazać elementy, których nie da się potwierdzić wyłącznie na podstawie dostępnych plików.
Mapa braków może wskazywać brakujące dane, niejasną procedurę, sprzeczne wersje, brak ilustracji lub źródła grafiki, niespójne ostrzeżenia, brak osoby zatwierdzającej albo nieustalony format dostawy. Nie uzupełnia samodzielnie danych specjalistycznych.
Struktura instrukcji zależy od produktu i odbiorcy, dlatego nie stosuję jednego uniwersalnego spisu treści.
Architektura obejmuje hierarchię rozdziałów, kolejność informacji i sekwencje czynności, a także nagłówki, ostrzeżenia, uwagi, listy, numerację, tabele, podpisy, odsyłacze, spisy treści i indeksy, gdy dotyczą projektu.
System obejmuje również nagłówki i stopki, relację tekstu z ilustracją, wersjonowanie oraz style. Dzięki temu źródło może być prowadzone jako materiał do aktualizacji, lokalizacji i ponownego wykorzystania elementów, gdy pozwala na to jego model.
Tabele, ilustracje i schematy muszą wspierać czynność, a nie tylko wypełniać stronę.
Zakres może obejmować uporządkowanie tabel, ujednolicenie podpisów, integrację dostarczonych schematów, oznaczenia i numerację, rozmieszczenie ilustracji przy odpowiednich krokach, proste diagramy oraz aktualizację tekstu w edytowalnych grafikach.
Nie zakładam zaawansowanego modelowania CAD, automatycznego tworzenia specjalistycznej ilustracji technicznej ani dokumentacji konstrukcyjnej. Zakres nowych ilustracji zależy od danych i osobnego uzgodnienia, a dane przedstawione na ilustracji zatwierdza ekspert klienta.
Odpowiedzialności
Zakres produkcyjny jest jasny, a odpowiedzialność za dane specjalistyczne pozostaje po właściwej stronie.
Ekspert klienta
Odpowiada za działanie produktu, kolejność czynności, dane techniczne, ostrzeżenia, zagrożenia, środki bezpieczeństwa, procedury instalacji, użytkowania, konserwacji i serwisu, kompletność merytoryczną oraz zatwierdzenie dokumentu.
Autor techniczny
Może uczestniczyć tylko wtedy, gdy zakres jego pracy został osobno uzgodniony; nie jest automatyczną częścią każdej realizacji.
Lingwista
Jest właściwą osobą do tłumaczenia, terminologii, kontroli językowej i akceptacji przyszłych wersji językowych. Techniczny QA nie zastępuje tej kontroli.
Wymogi formalne
Wymagania prawne, regulacyjne, branżowe, normy, ocena zgodności i certyfikacja muszą zostać odrębnie określone oraz zatwierdzone przez właściwe osoby.
Proces tworzenia instrukcji
Dziesięć etapów od wiedzy o produkcie do dokumentu gotowego do publikacji.
01
Produkt, odbiorca i cel
- Materiał wejściowy
- Opis produktu, systemu, oprogramowania lub procesu oraz oczekiwany odbiorca.
- Działanie
- Ustalam przeznaczenie dokumentu i granice realizacji technicznej.
- Decyzja klienta
- Potwierdza cel, odbiorców i oczekiwany rezultat.
- Rezultat etapu
- Punkt startu oraz kryteria zakresu.
- Ryzyko do rozstrzygnięcia
- Nieokreślony odbiorca prowadzi do przypadkowej struktury dokumentu.
02
Materiały i osoby decyzyjne
- Materiał wejściowy
- Źródła, istniejące fragmenty, wymagania oraz wskazanie ekspertów.
- Działanie
- Porządkuję wejścia i ustalam, kto podejmuje decyzje merytoryczne i językowe.
- Decyzja klienta
- Wskazuje osoby zatwierdzające oraz dostępne materiały.
- Rezultat etapu
- Zestaw materiałów i odpowiedzialności do analizy.
- Ryzyko do rozstrzygnięcia
- Brak właściciela decyzji może zatrzymać pracę nad treścią specjalistyczną.
03
Analiza źródeł
- Materiał wejściowy
- Dokumenty, tabele, schematy, ilustracje, notatki i szablony.
- Działanie
- Rozdzielam materiały zatwierdzone, referencyjne i robocze oraz oceniam ich przydatność.
- Decyzja klienta
- Potwierdza, które źródła są aktualne.
- Rezultat etapu
- Inwentaryzacja źródeł i ograniczeń.
- Ryzyko do rozstrzygnięcia
- Stare lub sprzeczne pliki mogą wymagać ponownej decyzji eksperta.
04
Mapa informacji i braków
- Materiał wejściowy
- Inwentaryzacja źródeł oraz pytania z analizy.
- Działanie
- Oznaczam braki, sprzeczności, niejasne procedury, brak grafik i dane wymagające potwierdzenia.
- Decyzja klienta
- Ustala priorytety i sposób uzupełnienia braków.
- Rezultat etapu
- Lista zależności i decyzji przed produkcją.
- Ryzyko do rozstrzygnięcia
- Niepotwierdzone dane nie mogą stać się treścią instrukcji.
05
Projekt struktury
- Materiał wejściowy
- Potwierdzone informacje oraz mapa braków.
- Działanie
- Projektuję hierarchię, kolejność informacji, style, numerację i relacje tekstu z ilustracją.
- Decyzja klienta
- Akceptuje proponowaną strukturę i zakres dokumentu.
- Rezultat etapu
- Plan architektury dokumentu.
- Ryzyko do rozstrzygnięcia
- Zmiana struktury po rozpoczęciu pełnej produkcji zwiększa zakres korekt.
06
Próbka dokumentu
- Materiał wejściowy
- Plan struktury, szablon i reprezentatywne materiały.
- Działanie
- Przygotowuję próbkę układu, tabel, ostrzeżeń, ilustracji i stylów.
- Decyzja klienta
- Akceptuje kierunek szablonu i oznaczania zmian.
- Rezultat etapu
- Uzgodniony wzorzec do dalszej produkcji.
- Ryzyko do rozstrzygnięcia
- Brak akceptacji próbki utrudnia utrzymanie spójności całości.
07
Opracowanie produkcyjne
- Materiał wejściowy
- Zatwierdzona próbka i materiały do opracowania.
- Działanie
- Tworzę dokument, porządkuję zatwierdzoną treść i buduję system stylów oraz wersjonowania.
- Decyzja klienta
- Dostarcza brakujące dane i rozstrzyga pytania oznaczone podczas pracy.
- Rezultat etapu
- Wersja robocza dokumentu w ustalonej strukturze.
- Ryzyko do rozstrzygnięcia
- Braki w danych mogą ograniczyć tempo i zakres produkcji.
08
Tabele, ilustracje i ostrzeżenia
- Materiał wejściowy
- Wersja robocza oraz dostarczone zasoby wizualne.
- Działanie
- Integruję tabele, podpisy, schematy, grafiki, oznaczenia i ostrzeżenia w relacji do właściwych kroków.
- Decyzja klienta
- Zatwierdza dane oraz znaczenie elementów technicznych i wizualnych.
- Rezultat etapu
- Spójne elementy wspierające użycie dokumentu.
- Ryzyko do rozstrzygnięcia
- Brak źródeł grafiki lub danych ogranicza możliwość aktualizacji elementu.
09
Przegląd eksperta klienta
- Materiał wejściowy
- Wersja robocza oraz lista pytań i oznaczeń.
- Działanie
- Przygotowuję materiał do merytorycznej weryfikacji i wprowadzam zatwierdzone korekty.
- Decyzja klienta
- Ekspert zatwierdza dane, ostrzeżenia i procedury.
- Rezultat etapu
- Wersja po przeglądzie merytorycznym.
- Ryzyko do rozstrzygnięcia
- Brak akceptacji eksperta nie pozwala traktować danych jako potwierdzonych.
10
QA, eksport i dostawa
- Materiał wejściowy
- Zatwierdzona wersja dokumentu oraz wymagany format dostawy.
- Działanie
- Kontroluję strukturę, powtarzalność, odsyłacze, tabele i uzgodnione eksporty.
- Decyzja klienta
- Akceptuje finalny zakres plików i sposób przekazania.
- Rezultat etapu
- Dokument do publikacji wraz z uzgodnionym źródłem i raportem ograniczeń, gdy jest potrzebny.
- Ryzyko do rozstrzygnięcia
- Licencje fontów, grafik i zasobów mogą ograniczyć przekazanie części plików.
Rezultat dokumentacyjny
- uporządkowana instrukcja i kompletna struktura dokumentu
- źródło przygotowane do aktualizacji i lokalizacji
- szablon, system stylów, uporządkowane tabele i zintegrowane ilustracje
- raport braków albo decyzji, gdy był potrzebny
Formaty dostawy
- FrameMaker, InDesign, IDML albo Word
- PDF do druku albo publikacji cyfrowej
- inne uzgodnione eksporty
- format dobrany do celu, nie obiecywany z góry
Pliki otwarte
- przekazywane w uzgodnionym zakresie
- zależne od licencji fontów i grafik
- zależne od szablonów oraz innych zasobów
- oznaczone, gdy ograniczenia wpływają na dalszą edycję
Granice zakresu
- brak automatycznego autorstwa specjalistycznego
- wymogi prawne, normy i certyfikacja ustalane osobno
- tłumaczenie oraz QA językowe poza technicznym QA
- wynik zależny od zatwierdzonych danych klienta
Powiązane usługi
Kolejny krok może dotyczyć struktury FrameMaker/XML/DITA, odtworzenia źródła albo przygotowania wersji językowych.
Instrukcje i dokumentacja techniczna
Tworzenie, aktualizacja, rekonstrukcja PDF i techniczna lokalizacja instrukcji obsługi oraz dokumentacji technicznej.
FrameMaker, XML i DITA
Projektuję i rozwijam dokumentację FrameMaker oraz XML/DITA: strukturę informacji, migracje, publikację wielokanałową i przygotowanie do lokalizacji.
Rekonstrukcja z PDF
Oceniam PDF i dostępne zasoby, a następnie odtwarzam dokument w uzgodnionym formacie do aktualizacji, tłumaczenia lub ponownej publikacji.
Lokalizacja instrukcji i dokumentacji
Techniczna lokalizacja istniejących instrukcji obsługi i dokumentacji z dostarczonymi tłumaczeniami.
Odpowiedzi
FAQ: tworzenie instrukcji i dokumentacji
Pytania o materiały wejściowe, odpowiedzialność i rezultat pracy.
Potrzebne są materiały o produkcie, systemie lub procesie: dane, procedury, tabele, ilustracje, wcześniejsze dokumenty, wymagania publikacji i osoby odpowiedzialne za zatwierdzenie. Na początku wystarczy próbka oraz opis celu dokumentu. Analiza pokaże, które informacje są gotowe, a które wymagają decyzji eksperta klienta.
Nie zakładam pełnego autorstwa specjalistycznego bez udziału właściwej osoby. Ekspert klienta zatwierdza działanie produktu, kolejność czynności, dane techniczne, ostrzeżenia i procedury. Zakres techniczny może obejmować strukturę, skład, porządkowanie materiałów, QA i eksport, ale nie zastępuje akceptacji merytorycznej.
Zakres może obejmować instrukcje obsługi, użytkowania, instalacji, montażu, uruchomienia, konserwacji i serwisowe, podręczniki użytkownika oraz krótkie instrukcje. Dokumentacja może dotyczyć urządzenia, maszyny, oprogramowania, systemu, procesu albo innego rozwiązania technicznego. Ostateczna struktura zależy od odbiorcy i materiałów wejściowych.
Tak. Najpierw trzeba jednak ocenić, które fragmenty są aktualne, które są tylko referencją, a które wymagają zatwierdzenia lub przebudowy. Stare dokumenty mogą pomóc w strukturze i terminologii, ale nie powinny być automatycznie traktowane jako obowiązujące dane.
Ekspert klienta albo wskazana osoba odpowiedzialna za produkt. Dotyczy to danych technicznych, ostrzeżeń, środków bezpieczeństwa, kolejności czynności, procedur instalacji, użytkowania, konserwacji i serwisu. Realizacja techniczna może uporządkować dokument i wskazać braki, ale nie zatwierdza tych informacji.
Mogę integrować dostarczone ilustracje, porządkować tabele, przygotowywać proste diagramy, oznaczenia i podpisy oraz aktualizować tekst w edytowalnych grafikach. Specjalistyczna ilustracja techniczna, modelowanie CAD albo samodzielne tworzenie danych konstrukcyjnych wymagają osobnego uzgodnienia. Znaczenie i poprawność elementów zatwierdza ekspert klienta.
Nie. Narzędzie i model źródła dobiera się po analizie celu, skali, sposobu aktualizacji, planowanych wersji językowych i kanałów publikacji. InDesign, FrameMaker, XML albo DITA są możliwymi środowiskami pracy, ale klient nie musi wybierać ich przed pierwszą oceną.
Plik edytowalny można przekazać w uzgodnionym zakresie. Trzeba rozdzielić finalny eksport, na przykład PDF, od pliku roboczego, szablonu, fontów, grafik i innych zasobów. Przekazanie źródeł zależy od formatu, licencji i ustaleń projektowych.
Tak, jeśli taki cel zostanie uwzględniony przy strukturze, stylach, numeracji, grafikach i wyborze formatu źródłowego. To ułatwia późniejszą lokalizację, ale nie oznacza automatycznego tłumaczenia ani kontroli językowej. Warto ustalić przewidywane wersje już na początku.
Nie. Usługa nie jest certyfikacją, analizą prawną, formalną oceną zgodności ani potwierdzeniem bezpieczeństwa produktu. Wymagania regulacyjne, branżowe i normy muszą zostać odrębnie określone oraz zatwierdzone przez właściwe osoby.
Masz wiedzę i materiały, ale nie masz jeszcze spójnej instrukcji?
Opisz produkt lub system, rodzaj instrukcji, dostępne źródła, osoby zatwierdzające i oczekiwany rezultat. Możesz także wkleić link do próbki materiału.