Dokumentacja techniczna bywa obszerna i rzadko czytana w całości. Szuka się w niej jednej informacji, zwykle pod presją czasu.
Typowe pytania
O parametr, o zgodność, o sposób wykonania czynności, o numer części. Cztery rodzaje, z których każdy wymaga czegoś innego.
Pierwszy i czwarty to w gruncie rzeczy wyszukiwanie dosłowne — pada konkretna wartość albo oznaczenie. Drugi i trzeci są opisowe i tam warstwa znaczeniowa daje realną poprawę. Rozkład tych czterech typów w rzeczywistych pytaniach warto policzyć przed wdrożeniem.
Co trzeba przygotować
Pliki w postaci, z której da się wyciągnąć tekst. Instrukcje w formie skanów wymagają wcześniejszego rozpoznania znaków, a przy dokumentacji z tabelami rozpoznanie musi zachować układ kolumn. Do tego rozstrzygnięcie, które wydania są obowiązujące, i uporządkowane nazwy plików — bez tego wyniki nie dadzą się przypisać do produktu.
Tabele parametrów
Najtrudniejsze do indeksowania. Wiersz wyrwany z tabeli bez nagłówków traci znaczenie — podział na fragmenty musi to uwzględniać.
Sprawdza się dołączanie nagłówków kolumn do każdego wiersza albo trzymanie całej tabeli jako jednego fragmentu razem z jej tytułem. Wybór zależy od wielkości tabeli i od tego, czy pytania dotyczą pojedynczych wartości, czy porównań.
Rysunki i schematy
Zawierają oznaczenia, których nie ma w tekście. Odczyt opisów z rysunku wyraźnie poprawia kompletność wyszukiwania.
Osobną trudność sprawiają odesłania wewnętrzne. Instrukcje odsyłają do punktów i tabel samym numerem, a fragment zawierający wyłącznie odesłanie nie niesie żadnej treści. Takie miejsca warto łączyć z tym, do czego prowadzą, albo w ogóle pominąć w indeksie.
Wersje dokumentacji
Ta sama instrukcja dla kilku wersji produktu. Wynik musi wskazywać, której wersji dotyczy — inaczej wprowadza w błąd.
Informację o wersji trzeba zapisać przy każdym fragmencie, nie tylko w nazwie pliku. Wtedy da się zawęzić wyszukiwanie do konkretnego wydania, a użytkownik widzi przy wyniku, czego dotyczy. To samo dotyczy dat obowiązywania i statusu dokumentu.
Wskazanie miejsca
Numer strony i sekcji przy każdej odpowiedzi. Przy dokumentacji technicznej weryfikacja jest obowiązkowa.
Odpowiedź bez odnośnika do źródła jest w tym zastosowaniu bezużyteczna. Serwisant i tak musi zobaczyć oryginał, zanim cokolwiek zrobi, więc rola wyszukiwania kończy się na skróceniu drogi do właściwej strony.
Numer strony trzeba zapisać przy fragmencie w chwili indeksowania. Odtworzenie go później, na podstawie samego tekstu, bywa niewykonalne.
Dokumentacja producentów
Warto indeksować w oryginalnej formie, bez przepisywania. Aktualizacja po stronie producenta trafia wtedy do wyszukiwania sama.
Materiały obcojęzyczne nie muszą być tłumaczone, żeby dały się przeszukać pytaniem po polsku — opisuje to tekst o wyszukiwaniu w wielu językach.
Kiedy wystarczy zwykłe wyszukiwanie
Gdy dokumentacja jest jedna, dobrze podzielona i ma spis treści, a pytania dotyczą numerów części. Zwykłe wyszukiwanie pełnotekstowe w czytniku plików obsłuży to bez żadnej dodatkowej warstwy.
Granica przebiega tam, gdzie pojawia się kilka wydań, kilku producentów i pytania zadawane opisowo przez osoby, które tej dokumentacji nie pisały. Dopóki korzysta z niej dwóch serwisantów znających ją niemal na pamięć, nakład na wdrożenie zwraca się trudno.
