poniedziałek, 11 lipca 2011

O dokumentacjach IBM słów kilka

Często w naszej pracy z produktami podstawowe źródło wiedzy stanowią ich dokumentacje. Nie inaczej wygląda pozyskiwanie informacji na temat oprogramowania sygnowanego marką IBM. Co więcej, Centra informacyjne stanowią tak wygodny interfejs dostępu, że ich omówienie jest niekiedy elementem szkolenia (np. najlepszych moim zdaniem szkoleń Artura Wrońskiego na temat DB2).
Aby znaleźć dokumentację interesującego nas produktu w ramach dowolnej wyszukiwarki wpisujemy jego nazwę dołączając frazę Information Center. Dla przykładu będziemy posługiwać się dokumentacją najbliższego mi produktu IBM, czyli DB2. Wpiszmy zatem IBM DB2 9.7 Information Center. Powinniśmy wówczas otrzymać rezultat podobny do poniższego:



Wybieramy pierwszą pozycję, to jest odnośnik z adresem http://publib.boulder.ibm.com/infocenter/db2luw/v9r7/index.jsp. Zanim jednak przejdziemy do omówienia interfejsu dokumentacji i jego użytecznych funkcji, warto pokusić się o pewną uwagę. W ramach adresu dokumentacji (prawie) każdego produktu określana jest jego wersja. W naszym przypadku widzimy zapis v9r7 co odpowiada wersji 9.7. Zmieniając go na v9 czy v9r5 możemy w łatwy sposób zmienić wcześniejszą wersję motoru danych.

Niezależnie jednak od wersji (a nawet od produktu) otrzymujemy jednak taki sam, oparty na platformie Eclipse, interfejs:



Po jego lewej stronie mamy zakładki ze spisem treści, indeksem oraz wynikami wyszukiwania. Po prawej zaś obszar treści z paskiem narzędzi. Zarówno lokalizacja interfejsu jak i samej zawartości są ściśle powiązane z ustawieniami językowymi przeglądarki. W przypadku języka polskiego należy jednak liczyć się z faktem, że nie wszystko jest obecnie przetłumaczone. Najczęściej jednak wszyscy i tak zmieniają język na angielski.

Wyszukajmy w dokumentacji informacje o poleceniu db2look i z otrzymanych wyników wybierzmy pierwszą pozycje:



Widzimy, że wszystkie wystąpienia wyszukanej frazy są podświetlone w ramach treści. Czasem powoduje to jednak zmniejszenie czytelności wyświetlanego tekstu. Dlatego posłużymy się ikoną markera z paska narzędzi. Jednocześnie wybierzmy opcję wyszukania obecnie wyświetlanego tematu w spisie treści:



Otrzymamy widok podobny do poniższego:



Funkcjonalność wyszukiwania elementu w spisie treści wykorzystywana może być w przypadku, gdy nie potrzebujemy znaleźć element, którego nazwę zapomnieliśmy. W naszym przykładzie wyświetlenie komendy db2look w spisie treści umożliwia znalezienie potrzebnego nam w danej chwili polecenia administracyjnego.

Ostatnią kwestią jest przekazywanie hiperłącza do konkretnego elementu dokumentacji. W tej kwestii musimy otworzyć ten element korzystając z opcji Otwórz w nowej zakładce (nowym oknie) bądź użyć opcji Kopiowania łącza w przeglądarce. W przeciwnym wypadku skopiujemy początkowy adres dokumentacji produktu.

Być może ktoś z Was zna jeszcze inne ciekawe funkcje dokumentacji IBM. Czekam na komentarze.

Brak komentarzy: