Wsparcie urządzeń telekomunikacyjnych i B2B musi zachowywać kontekst dostarczonego sprzętu, oprogramowania i instalacji. Strona produktu z instrukcjami może połączyć instalatora lub zespół serwisowy z właściwym zadaniem, nie zakładając, że każde urządzenie z danej rodziny produktów ma taką samą konfigurację.
Wsparcie urządzeń telekomunikacyjnych i B2B musi zachowywać kontekst dostarczonego sprzętu, oprogramowania i instalacji. Strona produktu z instrukcjami może połączyć instalatora lub zespół serwisowy z właściwym zadaniem, nie zakładając, że każde urządzenie z danej rodziny produktów ma taką samą konfigurację.
Użyj poniższych informacji, aby zgłoszenie lub zadanie można było zweryfikować: model sprzętu, wersja sprzętowa, wersja oprogramowania, zainstalowane moduły, sekcja źródła, status instalacji. Zapisz, co zostało potwierdzone, a co pozostaje nieznane, a następnie skorzystaj z właściwego źródła produktu, aby ustalić kolejny zatwierdzony krok.
Zapisz model produktu, wersję sprzętową oraz widoczną wersję oprogramowania lub interfejsu, jeśli ma to znaczenie. Powiąż z urządzeniem zainstalowane moduły i akcesoria. Sama nazwa produktu handlowego może nie wskazywać właściwego ekranu konfiguracji, listy części ani zatwierdzonej procedury serwisowej.
Powiąż zatwierdzone wymagania wstępne instalacji z dokumentacją dostarczonego sprzętu. Oddziel konfigurację produktu od procesu konfiguracji i odbioru prowadzonego przez sam obiekt. Przewodnik wizualny powinien objaśniać instrukcje źródłowe, nie wymyślając wymagań dotyczących okablowania, ustawień sieci ani innych warunków konkretnego obiektu.
Użyj właściwego rysunku lub oznaczonego widoku, aby wskazać złącze albo moduł wymieniony w instrukcji. Zachowaj zatwierdzone odniesienie i orientację. Podobne złącza fizyczne mogą mieć różne funkcje, dlatego sam wygląd nie zastępuje udokumentowanej identyfikacji połączenia.
Przykładowa sprawa wsparcia: instalator zapisuje oznaczenie sprzętu i widoczną wersję oprogramowania, a następnie zgłasza sekcję źródła, która przestała być zgodna. Wsparcie sprawdza właściwy dokument konfiguracji. Przewodnik nie wymyśla równoważnego polecenia ani ścieżki w menu z innej wersji.
Zapisz dostarczone moduły, wersję źródła, status konfiguracji i nierozstrzygnięte pytania dla kolejnego zespołu. Nie umieszczaj poufnych danych uwierzytelniających w ogólnym podsumowaniu przekazania. Odpowiedzialny właściciel obiektu zachowuje uprawnienia do dostępu i odbioru, zamiast przekazywać tę decyzję przyciskowi ukończenia przewodnika.
Wybierz zadanie z jasnym zatwierdzonym źródłem i omów je z właścicielami produktu i instalacji. Zmierz poprawność wyboru wersji i brakujące pola przekazania. Jako pierwszy wynik oceń przejrzystość dokumentacji, nie przypisując niezawodności wdrożenia ani dostępności usług samemu korzystaniu z przewodnika.
Przygotuj zapis dla przewodników instalacji i wsparcia urządzeń telekomunikacyjnych i B2B, łączący źródło z konkretnym zadaniem. Skopiuj poniższe pola kontekstowe do własnego procesu produktowego, wsparcia lub przeglądu. Dodaj odnośnik do właściwego źródła i osobę odpowiedzialną, aby kolejny zespół widział, co wymaga potwierdzenia.
Zapisz model sprzętu, wersję, wersję oprogramowania i wskaż właściwe źródło.
Użyj scenariusza o możliwości śledzenia przekazania po instalacji do omówienia zakresu, a następnie przejrzyj rzeczywiste zadanie i nierozstrzygnięte pola z osobą odpowiedzialną.
Dołącz zainstalowane moduły, sekcję źródła, status instalacji i nierozstrzygnięte pytanie do utworzonego zapisu.
Typowe zgłoszenie dotyczące dokumentacji wymaga zwykle identyfikatorów produktu, wersji i opisu nieudanej czynności. Nie umieszczaj danych uwierzytelniających w takim podsumowaniu. Gdy specjalista potrzebuje dostępu, skorzystaj z autoryzowanego procesu danego obiektu.
Zacznij od właściwej dokumentacji i dostępnych materiałów wizualnych, a także modelu sprzętu, wersji sprzętowej i wersji oprogramowania. Wybierz jedno powtarzające się pytanie i poproś właściciela produktu o sprawdzenie właściwego źródła przed rozbudową przewodnika.
To ilustracyjny scenariusz tworzenia treści lub wsparcia, a nie studium przypadku klienta ani zmierzony wynik. Użyj go do omówienia wymaganego kontekstu produktu i przeglądu rzeczywistego zadania z właścicielem źródła.
Przynieś jeden produkt i zatwierdzone źródło dotyczące powtarzającego się pytania. Ukierunkowana prezentacja może pokazać, jak podpisane ilustracje, sprawdzone kroki lub czytelniejszy zapis wsparcia pomagają uwzględnić model i wersję sprzętu. Uzgodnij przygotowanie i przegląd przed rozszerzeniem rozwiązania.
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.
