E-log — ogarnianie chaosu

jjb

2022/01/01

Categories: informatyka Tags: logi dokumentacja edycja online pisanie

Table of Contents

Tęsknimy za dokumentacją

Podobnie, jak za porządkiem. Bo w gruncie rzeczy wszyscy lubimy porządek, ale jedni potrafią go utrzymać, a inni nie. Oczywiście porządek dla różnych osób może oznaczać coś zupełnie innego.

Baza wiedzy

Uporządkowana informacja, z odsyłaczami, wyjaśnieniami, coś co pozwala nam szybko ogarnąć jakoweś pojęcia, idee, czasem procedury. W pracy grupowej w IT bardzo potrzebna. Ale oczywiście powinna być aktualizowana. I tu jest pewien problem. Dokumentacja całościowa w postaci dokumentu z odnośnikami wymaga przy zmianach dużego nakładu pracy oraz wiedzy o zależnościach, etc.

Tworzenie takiej dokumentacji można sobie ułatwić korzystając z WIKI. Pozwala to ludziom, którzy mają niewiele do wniesienia do dokumentacji rozumianej jako całość, wnieść swoje uwagi, często dosyć istotne technicznie, szybko oraz w odpowiednim kontekście. Innymi słowy taka baza wiedzy może się składać z wielu małych fragmentów, ale powiązania pomiędzy nimi oraz możliwość wprowadzania słów kluczowych i wyszukiwania czynią z WIKI mocne narzędzie.

Ostatnia wersja prawdy

Często zmienia się sposób konfiguracji, pojawiają nowe pomysły i ważna staje się oś czasu — kiedy takie czy owe zmiany się pojawiły, co było istotne, etc. WIKI spiętę z systemem kontroli wersji sprawdza się tu znakomicie.

Potrzebne — niepotrzebne

Roli pewnych informacji możemy nie docenić. Może być też tak, że bardzo trudno pewnego rodzaju komunikaty systemowe, wyniki debugowania, etc. odpowiednio zaklasyfikować. Mogą to być artefakty, konsekwencje błędów w zupełnie innych obszarach. Wtedy WIKI, które wymusza jakiś porządek kategorii zaczyna być kłopotliwe. Co zrobić z taką informacją? Na ogół ginie ona wraz z wyrotowanymi dziennikami.

E-log

Dla informacji, których znaczenia jeszcze do końca nie znamy właśnie projekt E-log jest przeznaczony. Electronic Logbook powstał na potrzeby CERN-u. W eksperymentach gdzie zaangażowanych jest wielu ludzi oraz zbierane są dane z setek detektorów, dla analizy tych danych wszelkie artefakty, informacje dotyczące anomalii, etc. mogą być bardzo istotne. Trzeba je jednak gdzieś zapisać…

Moim zdaniem to niedoceniany projekt, nie zachęca na pierwszy rzut oka strona projektu, ale to bardzo pomocne i szybkie narzędzie pozwalające zapisywać a potem przeszukiwać informacje na różne sposoby. Znakomicie sie sprawdza, jako narzędzie pracy osobistej, ale możemy też zastosować różne rodzaje autoryzacji — od zapisu kont oraz haseł w plikach tekstowych do powiązania autoryzacji z infrastrukturą zarządzania tożsamością co daje nam możliwość pracy zespołowej, tym bardziej, że możemy przydzielać różne prawa dostępu…

W wielu dystrybucjach e-log możemy zainstalować za pomocą menadżera pakietów (apt, yum, dnf, urpmi …), ale dostępne jest też spakowane archiwum tar na stronie projektu.

>> Home