Praktyczna struktura obejmująca tożsamość produktu, części, narzędzia, ilustracje kroków, kontrole ukończenia i przekazanie do wsparcia.
Szablon instrukcji montażu to powtarzalna struktura wyjaśniająca właściwy produkt, warunki wstępne, części, działania i oczekiwany wynik. Uzupełnij go zatwierdzoną procedurą dla konkretnego modelu, a następnie przetestuj z osobą, która wcześniej nie montowała tego produktu.
Ten szablon porządkuje dokumentację. Nie określa uniwersalnej metody montażu ani nie zastępuje przeglądu technicznego właściciela produktu.
Zapisz nazwę produktu, model, wariant, wersję dokumentu, język, właściciela zatwierdzenia i datę przeglądu. Wymień objęte modele oraz wyłączenia. Określ, czy czytelnik jest nabywcą, instalatorem czy przeszkolonym technikiem. Użytkownik powinien ustalić zakres zastosowania przed rozpakowaniem lub rozpoczęciem pracy.
Wymień oczekiwane opakowania, wymagane narzędzia, potrzeby dotyczące przestrzeni roboczej i ostrzeżenia określone przez producenta. Oddziel dostarczone elementy mocujące od tych, które użytkownik musi zapewnić. Podaj przewidywany czas i liczbę osób tylko wtedy, gdy zostały ustalone dla tego produktu. Wyjaśnij, jak zgłosić niekompletną dostawę przed rozpoczęciem montażu, którego nie da się ukończyć.
Dla każdego elementu podaj oznaczenie w instrukcji, zatwierdzony opis, ilość i przydatne zdjęcie. Jeśli jest dostępny, dodaj oficjalny indeks. Zachowaj wymiary lub kody wykończenia odróżniające elementy zgodnie ze źródłem. Oznaczenie takie jak A lub 12 to etykieta ilustracji; nie przedstawiaj go jako numeru części do zamówienia, chyba że producent używa go właśnie w ten sposób.
Dla każdego kroku użyj zapisu: numer kroku; warunki wstępne; użyte części/narzędzia; jedno działanie; odpowiedni obraz lub widok; oczekiwany wynik; ostrzeżenie ze źródła oraz następny krok lub ścieżka wsparcia. Nie łącz niepowiązanych działań w jednej animacji. Zadbaj o czytelny tekst, aby zrozumienie nie zależało od ruchu, koloru ani małego znacznika interaktywnego.
W kroku dotyczącym szafki można poprosić czytelnika o wskazanie przedstawionej wewnętrznej strony panelu, pokazać dwie możliwe orientacje i wyjaśnić oczekiwane wyrównanie. Weryfikujący porównuje widoki z zatwierdzoną instrukcją i rzeczywistymi częściami. Zapisz udokumentowaną orientację i wynik; nie wymyślaj specyfikacji mocowania, aby szablon wyglądał na kompletny.
Dodaj listę kontrolną ukończenia producenta, informacje o pozostałych opakowaniach lub częściach zapasowych oraz ścieżkę zgłaszania nierozstrzygniętych kwestii. Poproś wsparcie o zebranie modelu, numeru kroku i, jeśli to właściwe, zdjęcia. Przed publikacją sprawdź liczbę elementów, indeksy, odnośniki, tłumaczenia i wszystkie pokazane orientacje. Po zmianie wersji produktu ponownie sprawdź odpowiednie kroki.
Użyj jednego modelu i rzeczywistej zawartości jego opakowania.
Poproś właściciela technicznego o potwierdzenie działania i wyniku.
Popraw niejednoznaczne etykiety i decyzje przed rozpowszechnieniem.
Użyj najmniejszego spójnego działania, które czytelnik może wykonać i zweryfikować. Podziel krok, jeśli dotyczy innej części, znacznie zmienia punkt widzenia lub wymaga osobnej decyzji.
Tak. Tożsamość produktu, odnośniki do części i kontrole kroków przydają się w obu formatach. Przygotuj materiały wizualne odpowiednie dla każdego formatu, zachowując spójność procedury.
Podaj szacunki czasu i wymaganej liczby osób właściwe dla produktu na podstawie zatwierdzonej dokumentacji lub odpowiednio sprawdzonego badania zadania. Nie kopiuj liczby z podobnego produktu.
Oznacz ten krok do przeglądu technicznego. Nie uzupełniaj luki wiarygodnie brzmiącą instrukcją i nie publikuj jej jako zatwierdzonej.
Wyślij zatwierdzoną instrukcję, schematy lub zdjęcia, które już masz. Poproś o bezpłatne demo przewodnika, aby zespół mógł przeanalizować jedno zadanie dotyczące produktu przed decyzją o jego rozszerzeniu.
