GoldenLine
Zaloguj się
Łukasz Kisielewicz

Łukasz Kisielewicz :]

Temat: Bieżąca dokumentacja

Witam,

Przeglądając oferty pracy, w kilku z nich, w wymaganiach stawianych przyszłym pracownikom napotkałem na punkt: prowadzenie bieżącej dokumentacji.

Czy prowadzicie taką dokumentację? Jeśli tak to w jakiej formie? Co w niej umieszczacie?

Czy jest to zwykły plik tekstowy z wpisami:

2009-12-15: Aktualizacja oprogramowania X
2009-12-16: Podłączenie nowej drukarki do sieci

czy może specjalna aplikacja?

Dziękuję za odpowiedzi
Link do wypowiedziLink

konto usunięte

Temat: Bieżąca dokumentacja

A roznie z tym bywa. Czasami wpisy do dokumentacji dotycza wybranej zmiany w danym systemie. A czasami trzeba pisac cala dokumentacje jak np. powstaje nowy system. O ile pierwszy wariant nie jest "upierdliwy" to za to drugi skutecznie popsuje Ci humor na kilka/nascie nastepnych dni. Co do formy dokumentacji to na ogol jest to jakies doc wordowy.
Link do wypowiedziLink
Łukasz Kisielewicz

Łukasz Kisielewicz :]

Temat: Bieżąca dokumentacja

Oczywistą sprawą jest pisanie dokumentacji do nowego systemu, nowej sieci itp. Ale czy to można nazwać dokumentacją **bieżącą**?

Ogłoszenia o pracę, które skłoniły mnie do napisania tego posta, dotyczyły informatyków w urzędzie/administratorów sieci (już istniejących). Co w takich przypadkach oznacza prowadzenie bieżącej dokumentacji? Czy nie chodzi tu o stworzenie jakiegoś miejsca, w którym zapisywane będą informacje o aktualizacjach, instalacjach nowych aplikacji, podłączaniu nowych urządzeń... po to by, w sytuacji gdy za tydzień pół urzędu nie może pracować, można było przeanalizować co też ostatnio było robione i na co zwalić winę :) Tak to sobie wyobrażałem.Łukasz Kisielewicz edytował(a) ten post dnia 16.12.09 o godzinie 09:11
Link do wypowiedziLink
Damian Januszek

Damian Januszek Administrator
Systemów

Temat: Bieżąca dokumentacja

Witam
W moim przypadku głównie są to schematy różnych maści w ms visio 'przeklajane' do worda.
Co się tyczy szczegółów.
1. Nie ma większego sensu prowadzenia dokumentacji o aktualizacjach - wszystko realizuje wsus.
2. Co się tyczy podłączenia nowej drukarki do sieci - to warto dodać taki wpis do schematu sieci (visio + generowanie raportów).
Link do wypowiedziLink
Rafał S.

Rafał S. Czasami I. Czasami
T.

Temat: Bieżąca dokumentacja

Witam,

Generalnie gdy pracowałem jako Administartor to rozróżnialiśmy trzy rodzaje dokumentacji.. no w zasadzie 4.

1. Baza wiedzy
Opis wszystkich systemów łącznie z załączonymi schematami (m.in. w visio). Opis przeróżnego rodzaju instrukcji obsługi systemów, procedur zmian itp.
2. System zarządzający projektami
Spis wszystkich projektów, statusy, wymagane dokumenty, odpowiedzialne osoby itp.
3. Raporty
Raporty dla "wyższych rangą" z systemów monitoringu nt. dostępności systemów, ilości incydentów, ilości załatwionych spraw itp.
4. Kontrola wersji
Tutaj załatwialiśmy to SVN`ami i podobnymi rzeczami. Umożliwiało to podgląd na to co, kto i kiedy zmienił.

Mysłę, że pracodawca dając w wymaganiach "prowadzenie dokumentacji technicznej" miał na myśli co najmniej jeden z tych punktów, a na 90% chodzi mu o punkt 1.
Link do wypowiedziLink
Krzysztof W.

Krzysztof W. Technical Project
Manager, Capgemini
Polska

Temat: Bieżąca dokumentacja

Inne przyklady sposobow przechowywania dokumentacji:

- Wiki odpowiednio skategoryzowane na odpowiednie procesy: Incident Management, Problem Management, Change Management, itd... a tam odpowiednie procedrury do kazdego przypadku,

- SharePoint lub eRoom lub jakis inny system Enterprise Content Management, gdzie mozna trzymac skatalogowane dokumenty w roznych formatach, glownie dokumenty tekstowe i arkusze. Zaleta ECM jest kontrola wersji dokumentow, kazda zmiana moze byc audytowana,

- folder wspoldzielony na dysku sieciowym, to takie ECM dla ubogich, szybszy dostep, ale mniejsza kontrola,

- wszelkiej masci systemy CMDB (Configuration Management Database), moga byc gotowe rozwiazania lub wlasne bazy danych gdzie w zaleznosci od potrzeb trzymac informacje o hostach, adresach, zawartosci waznych plikow systemowych, zainstalowanych pakietach. Tutaj przydaje sie bardzo automatyzacja, tak aby systemy byly regularnie skanowane i informacje uzupelniane samoczynnie, aby nie klepac tego recznie.

Pozdrawiam,
Link do wypowiedziLink

konto usunięte

Temat: Bieżąca dokumentacja

Wiki + Remedy
Link do wypowiedziLink
Mariusz Gronczewski

Mariusz Gronczewski Linux Geek

Temat: Bieżąca dokumentacja

Do "dokumentacji" (bardziej logowania) zmian w configach jest taki fajny pakiet etckeeper, zapisuje zmiany w Gicie, który potem można np. wrzucać na centralny serwer, dzieki temu wiadomo gdzie kiedy (i przy odrobinie współpracy między adminami) kto zrobił daną zmianę + możliwość banalnego "rollbacku" do ostatniego działającego configa.

A do typowej dokumentacji najlepsze jest chyba wiki, dostęp spod wszystkiego, (nawet komórki jak trzeba) wersjonowanie itp. Przydaje się wiki z RSSami wtedy można "zasubskrybować" zmiany, przydatne jak parę osób tworzy (sam lubie dokuwiki, RSSy out of the box i nie wymaga bazy SQL ;] )
Link do wypowiedziLink
Grzegorz Wiśniewski

Grzegorz Wiśniewski Informatyk, Urząd
Skarbowy

Temat: Bieżąca dokumentacja

Łukasz Kisielewicz:
Oczywistą sprawą jest pisanie dokumentacji do nowego systemu,
nowej sieci itp. Ale czy to można nazwać dokumentacją **bieżącą**?

Ogłoszenia o pracę, które skłoniły mnie do napisania tego posta, dotyczyły informatyków w urzędzie/administratorów sieci
(już istniejących). Co w takich przypadkach oznacza prowadzenie
bieżącej dokumentacji? Czy nie chodzi tu o stworzenie jakiegoś
miejsca, w którym zapisywane będą informacje o aktualizacjach,
instalacjach nowych aplikacji, podłączaniu nowych urządzeń...
po to by, w sytuacji gdy za tydzień pół urzędu nie może pracować, można było przeanalizować co też ostatnio było robione i na co zwalić winę :) Tak to sobie wyobrażałem.

Kolego Łukaszu od strony Urzędu/-ów (tu stary "urzędas" ;) Tobie napisze z doświadczenia) wygląda to zazwyczaj jako prowadzenie tzw. "Dziennika Systemu" czyli:

Dla kazdego serwera:
Data operacji:Godzina:Co zrobiono/co się stało:Kto wykonał:podpis

Ujmowane są w tym wszystkie aktualizacje oprogramowania, instalowane wersje systemu i aplikacji, wydarzeń krytycznych, interwencji serwisu itp. itd.
Forma prowadzenia tego w zależności od Urzędu, ale na mój nos w przeważającej większości papierowa (bo tak mówią w 99% procedury) lub czasami jakiś arkusz kalkulacyjny (ale arkusz jeśli ktoś prowadzi to zazwyczaj pomocniczo tylko).

Jak kontrola przyjdzie z instancji wyższej to i tak chce papier...Grzegorz Wiśniewski edytował(a) ten post dnia 16.12.09 o godzinie 13:14
Link do wypowiedziLink
Michał Panasiewicz

Michał Panasiewicz Administrator
systemów, sieci i
aplikacji.

Temat: Bieżąca dokumentacja

Korzystanie z systemów takich jak:
GLPI + pluginy,
Nagios + Nareto + NagVis
Wiki + skrypty które na przykład wklejają zmiany w konfiguracji
Poczta + changetrack
Wspomniane już przesyłanie zmian do systemu kontroli wersji (CVS,SVN,GIT)

Generalnie jak największa część powinna być zautomatyzowana, dzięki czemu rzeczywiście mamy bieżącą dokumentacje systemu i bieżący wgląd w zmiany.

Prowadzenie dokumentacji papierowej IMHO mija się często z celem (inna sprawa wydruk dokumentacji bieżącej), gdyż jest ona w chwili pisania często już nieaktualna.Michał Panasiewicz edytował(a) ten post dnia 16.12.09 o godzinie 13:58
Link do wypowiedziLink
Paweł R.

Paweł R. System administrator

Temat: Bieżąca dokumentacja

Zbigniew G.:
nie jest "upierdliwy" to za to drugi skutecznie popsuje Ci humor na kilka/nascie nastepnych dni. Co do formy dokumentacji to na ogol jest to jakies doc wordowy.

Może źle rozumiem definicje "dokumentacji nowego systemu", ale moim zdaniem jest to dużo prostsze niż pisanie dokumentacji utrzymaniowej. Robisz instalacje i od razu wszystko wrzucasz w jakiś dokument (dodanie usera, instalacja softu, co wrzucić w pliki konfiguracyjne itp).

Dokumentacja utrzymaniowa według mnie jest trudniejsza bo każdy upgrade/zmianę trzeba opisywać i pilnować aby wszyscy zainteresowani to robili.

Mój schemat pracy z dokumentacją wygląda mniej-więcej tak:

[*] Dokumentacja instalacji nowego systemu - czyli co trzeba zrobić żeby dany system uruchomić OD ZERA
[*] Procedury do typowych operacji (zestawienie/failover replikacji, dodanie usera, blokowanie dostępu, testowanie backupów, procedury budowania własnych pakietów itd)
[*] Po każdej awarii "post-mortem" - jak na przyszłość szybko zdiagnozować czy to taki sam przypadek + procedura "wyjścia" z problemu
[*] Dokumentacja konfiguracji systemu (co gdzie stoi, na jakich portach, w jakiej wersji) generuje się sama i wrzuca do wiki (z automatu dostajemy aktualną wersję + historię zmian)
[*] Automatyczne generowanie grafów tam gdzie ułatwia to pojęcie systemu (co z czym gada/czego wymaga) i wrzucanie do wiki

Dobre rozwiązanie podał także Mariusz - etckeeper. Dobrze wiedzieć że ktoś coś zmienił żeby ew. szybko rollbackować. Szczególnie jest to przydatne gdy pracuje się na zmiany i kolega z poprzedniej zmiany np.: podpiął ekspres do kawy do switcha :)

Myślę też że warto pisać procedury w taki sposób aby nawet osoba słabo znająca linuksa była w stanie je wykonać poprawnie.
Link do wypowiedziLink
Grzegorz Wiśniewski

Grzegorz Wiśniewski Informatyk, Urząd
Skarbowy

Temat: Bieżąca dokumentacja

Michał Panasiewicz:
Prowadzenie dokumentacji papierowej IMHO mija się często z celem
(inna sprawa wydruk dokumentacji bieżącej), gdyż jest ona w chwili pisania często już nieaktualna.

Wszystko ładnie pięknie, ale jak już pisałem: kolega Łukasz pisał o pracy w jakimś urzędzie (nie korporacji czy jakiejś "normalnej" firmie)... Nie oszukujmy się w 99% Urzędów wymagana (mi. przez procedury wewnętrzne) jest dokumentacja papierowa (tu akurat poruszam się po własnym i znajomych podwórku).

I sam tego nie zmieni choćby stawał na uszach klaskając przy tym nosem :), z powodu co podałem powyżej. Praktycznie każda kontrola z wyższej instancji wymaga papierowej dokumentacji i tyle.

Poza tym tego rodzaju dokumentacja ogranicza się zazwyczaj do tego co podałem wyżej więc luzzzz ;).Grzegorz Wiśniewski edytował(a) ten post dnia 16.12.09 o godzinie 14:55
Link do wypowiedziLink
Michał Panasiewicz

Michał Panasiewicz Administrator
systemów, sieci i
aplikacji.

Temat: Bieżąca dokumentacja

Grzegorz Wiśniewski:
...
... Nie oszukujmy się w 99% Urzędów wymagana (mi. przez procedury wewnętrzne) jest dokumentacja papierowa (tu akurat poruszam się po własnym i znajomych podwórku).

I sam tego nie zmieni choćby stawał na uszach klaskając przy tym nosem :), z powodu co podałem powyżej. Praktycznie każda kontrola z wyższej instancji wymaga papierowej dokumentacji i tyle.

Dlatego istnieje coś takiego jak "wydruk dokumentacji" :)
Poza tym tego rodzaju dokumentacja ogranicza się zazwyczaj do tego co podałem wyżej więc luzzzz ;).Grzegorz Wiśniewski edytował(a) ten post dnia 16.12.09 o godzinie 14:55
Link do wypowiedziLink
Grzegorz Wiśniewski

Grzegorz Wiśniewski Informatyk, Urząd
Skarbowy

Temat: Bieżąca dokumentacja

Michał Panasiewicz:
Dlatego istnieje coś takiego jak "wydruk dokumentacji" :)

Hmmm niby tak, ale nie do końca...
Chcąc być w porządku z procedurami to byśmy po każdym wpisie musieli drukować jakąś kartę czynności i potwierdzać ją własnym podpisem.
Czy to ma sens? Dla mnie osobiście nie, bo szkoda papieru (oczywiście możemy teraz zacząć debatę o wielkości kartki i czcionki :) ).
Krótki wpis
16.12.2009; 16:30; instalacja SC45 + Backup UW; GW; podpisik
= 10 sek. i po sprawie, a na stronie zmieścisz tego z 30 szt.

Jest też 2 strona medalu, która przemawia za - tzn. późniejszy dostęp do wyszukiwania operacji, statystyk itp. Ale skoro tych danych nikt i tak nie wykorzysta to po co?

Szkoda że Łukasz nie napisał co to za urząd bo można by powiedzieć coś więcej... ale jeśli to szeregowy urząd będący na końcu łańcuszka państwo-petent sprawa wszedzie będzie wyglądać tak samo lub bardzo podobnie. Po prostu procedury są choć dosyć skostniałe to jednak działające i sprawdzone. A wprowadzenie nowych wcale nie jest takie proste jak to w prywatnych firmach. I to wcale nie przez opisywany wielokrotnie w prasie opór "materii" :).
Link do wypowiedziLink
Łukasz Kisielewicz

Łukasz Kisielewicz :]

Temat: Bieżąca dokumentacja

Panowie, bardzo dziękuję za wszystkie odpowiedzi.

Grzegorzu, pracuję w urzędzie (niewielkiego) miasta.
Nie interesują mnie wielkie systemy, SVNy i inne ciekawe, wymieniane przez Was rozwiązania.

W zupełności wystarczy mi "Dziennik systemu". Nie mam zbyt wielu serwerów i aplikacji stąd potrzebuję najprostszego rozwiązania.

Dziękuję raz jeszcze
Link do wypowiedziLink
Michał Panasiewicz

Michał Panasiewicz Administrator
systemów, sieci i
aplikacji.

Temat: Bieżąca dokumentacja

Grzegorz Wiśniewski:
Michał Panasiewicz:
Dlatego istnieje coś takiego jak "wydruk dokumentacji" :)

Hmmm niby tak, ale nie do końca...
Chcąc być w porządku z procedurami to byśmy po każdym wpisie musieli drukować jakąś kartę czynności i potwierdzać ją własnym podpisem.
Czy to ma sens? Dla mnie osobiście nie, bo szkoda papieru (oczywiście możemy teraz zacząć debatę o wielkości kartki i czcionki :) ).
IMHO żadnego.
Krótki wpis
16.12.2009; 16:30; instalacja SC45 + Backup UW; GW; podpisik
= 10 sek. i po sprawie, a na stronie zmieścisz tego z 30 szt.

Jest też 2 strona medalu, która przemawia za - tzn. późniejszy dostęp do wyszukiwania operacji, statystyk itp. Ale skoro tych danych nikt i tak nie wykorzysta to po co?

Podstawowe pytanie jest takie: Czemu ma służyć dokumentacja ?
Jeśli jedynie spełnieniu wymogów określonych przepisami to wystarczy pewnie taki dziennik.
Jeśli jednak masz kilku administratorów, jeśli potrzebujesz (a warto) mieć zapis co ty robiłeś/zmieniałeś ostatnio w konfiguracji (przydatne przy diagnozowaniu) to przynajmniej changetrack lub (wskazany przez mariusza) etckeeper okazuje się bardzo przydatny dodatkowo wysyłanie na wiki pozwala wygodnie przeglądać zmiany.
A i ktoś komu przekażesz później system będzie miał wgląd co było robione więc szybciej się wdroży.
Link do wypowiedziLink

konto usunięte

Temat: Bieżąca dokumentacja

Dokładnie. Dochodzi jeszcze taki element, że należy zostawić system w takim stanie, abyś każdego dnia mógł rzucić wszystko w czorty i następca szybko zorientuje się, co i jak działa
Link do wypowiedziLink
Łukasz C.

Łukasz C. Senior Technical
Architect

Temat: Bieżąca dokumentacja

hmm moze cos z kontrolowania workflow w projekcie? redmine, jira, trac itp ?
Link do wypowiedziLink
Tomasz Z.

Tomasz Z. kierownik internetu

Temat: Bieżąca dokumentacja

Krzysztof Stryjek:
Dokładnie. Dochodzi jeszcze taki element, że należy zostawić system w takim stanie, abyś każdego dnia mógł rzucić wszystko w czorty i następca szybko zorientuje się, co i jak działa


I moim zdaniem jest to bardzo dobre podejście do tematu.

Dokumentacja powinna być podzielona na dwie części.

1. opis systemu/aplikacji/sieci... (zmiany w zasadzie tylko przy dokładaniu/zamianie "klocków")

2. procedury awaryjne, hasła (procedury przetestowane, aktualne hasła i zasady dostępu do tych materiałów)

Forma składowania to rzecz drugorzędna.
Jeśli w organizacji mamy bazę na miarę ITIL'owego CMDB, to mamy pierwszą część w zasadzie załatwioną.

Jeśli idzie o część druga, tu polecał bym jednak przynajmniej fargmenty trzymać w formie papierowej i nie tylko w jednym miejscu.

tomekTomasz Zaborowski edytował(a) ten post dnia 22.12.09 o godzinie 09:40
Link do wypowiedziLink
« Wróć do tematów
Odpowiedz

Podobne tematy


Następna dyskusja:

Ekspertyzy Budowlane - doku...




Wyślij zaproszenie do
Anuluj