Od czerwca 2004 r. Jestem partnerem w trzyosobowej usłudze kontraktowej / konsultingowej. Wszyscy pracujemy głównie nad własnymi „kontami”, jednak musimy prowadzić dla siebie dokumentację, aby umożliwić „przełączenie awaryjne” między partnerami. Większość naszych klientów ma jakiś wewnętrzny personel IT, z których wielu wykonuje codzienną konserwację, a my również musimy im skutecznie przekazywać dokumentację.
Moi dwaj partnerzy mają tę zaletę (jeśli można to tak nazwać), że pracowali jako pracownicy pode mną w innej firmie, w wyniku czego obaj byli indoktrynowani moim opiniowanym sposobem robienia rzeczy. Ścisła spójność (gdzie oczywiście mogą istnieć) między konfiguracjami Klientów jest darem niebios. Oczywiście, produkty się zmieniają, dlatego prowadzimy dyskusję na temat nowych produktów / wersji itp. I decydujemy się na spójną strategię konfiguracji przed wdrożeniem. To nie byłoby skalowane do dużej firmy, ale szczerze mówiąc, widzę to raczej jako cechę niż błąd. (Nie zacznę gadać o większych firmach „zarządzanych usługach” z ich „inżynierami” i okropnymi tendencjami do jednorazowych, na wpół ocenianych „rozwiązań” i niespójności między klientami ...> uśmiech <)
Jestem zdecydowanie przeciwny „przerażającemu segregatorowi”. Nigdy nie widziałem, aby fizyczna dokumentacja była zawsze aktualna . Uważam, że marnowanie pieniędzy klienta spędza czas na fizycznym kopiowaniu dokumentacji. Wolę spędzać czas na opracowywaniu dokumentacji na podstawie danych „na żywo” z uruchomionych konfiguracji.
Jako przykład absolutnie nie będę utrzymywał arkuszy kalkulacyjnych z informacjami o adresie IP. Właśnie po to są DHCP i DNS (szczegóły poniżej). Jeśli te rzeczy nie działają, mamy poważne problemy.
Mamy klientów, którzy proszą o takie rzeczy, jak „zrób dokument, który pokazuje całą konfigurację naszych zasad grupy”, a ja kopnąłem po piętach i odmówiłem zrobienia tego. Moja powtarzająca się kontrpropozycja (która do tej pory działała) polegała na wprowadzeniu klienta w narzędzia administracyjne, które mogą zapewnić mu „samoobsługę” lub wykorzystanie oprogramowania do generowania „na żywo” przyjaznej dla klienta dokumentacji na żądanie.
Dokładamy wszelkich starań, aby zachować skrupulatność w pisowni rzeczy zwykłym angielskim. Nietechniczny kontakt z działem IT może na przykład sprawdzić członkostwo grupy Active Directory na komputerze i zobaczyć takie rzeczy, jak „Oprogramowanie - zainstaluj pakiet Microsoft Office 2010 Pro” i „Zasady grupy - automatyczne logowanie do komputera w kiosku wysyłkowym”. Nie potrzeba żadnej dokumentacji, aby wyjaśnić, co to znaczy.
Oto niektóre dane „na żywo”, których używamy:
Cała alokacja adresów IP jest przechowywana na serwerach DHCP - dotyczy to również urządzeń adresowanych statycznie (zaznaczone jako takie w komentarzach). Adresy MAC i IP można łatwo wyszukiwać za pomocą skryptów lub ręcznie, a dane z definicji muszą być aktualne, jeśli są wykorzystywane w produkcji.
Wszystko otrzymuje nazwę i rekord PTR w DNS. Większość hostów otrzymuje również rekord HINFO. Rzeczy wymagające pełnych opisów otrzymują rekord TXT.
W miarę możliwości obszerne i pełne użycie pól „Notatek” - Active Directory, opisów komputerów, opisów folderów współdzielonych itp. Jesteśmy również rozlegli i zrozumiali, np. Z nazwami grup zabezpieczeń.
Komentarze / uwagi w konfiguracjach narzędzi sieciowych (na przykład komentarze dotyczące list ACL, opisy portów, lokalizacja SNMP / informacje kontaktowe).
Jestem dość negatywnie nastawiony do przechowywania dowolnych informacji w plikach tekstowych, wiki itp. Struktura umożliwia dobre wyszukiwanie. Ilekroć mogę uzyskać ustrukturyzowany mechanizm pamięci masowej, który działa dla mnie (nawet jeśli oznacza to, że muszę napisać oprogramowanie, aby je zapytać), wolę to. Komentarze, które mogę przeanalizować z plików konfiguracyjnych, baz danych itp., Zawsze przekonują mnie, gdy są zestawiane z ręcznie wygenerowanymi dokumentami, które niemal natychmiast przestarzałe.
Kiedy musimy przechowywać informacje „w dowolnej formie”, korzystamy z własnego repozytorium SVN. Zawiera wszystkie różne fragmenty statycznej dokumentacji, które stworzyliśmy przez lata, złożone przez klienta. Używamy SVN do tego od 2004 roku i działa bardzo dobrze jako narzędzie współpracy dla nas. Wykonujemy wersje schematów baz danych, skryptów sysadmin, kopii zapasowych obiektów zasad grupy itp. Próbuję sprawdzić wszystko, co mogę, do kontroli wersji.
Bardzo łatwo jest przeszukać moją kasę za pomocą narzędzi indeksujących opartych na systemie plików. Wiem, że każdy z nas ma co najmniej jedną pełną kopię repozytorium dostępną lokalnie w dowolnym momencie. Udostępniliśmy również repozytorium za pośrednictwem uwierzytelnionego protokołu WebDAV za pośrednictwem protokołu SSL na wypadek, gdybyśmy absolutnie musieli uzyskać dostęp do przechowywanych tam danych i mieć dostęp tylko do przeglądarki.
Nigdy nie zostaliśmy o to poproszeni, ale chętnie utworzymy konto na serwerze SVN, aby umożliwić Klientowi wymeldowanie się i interakcję z własnymi plikami (jeśli mają oni tak chętny zasób wewnętrzny ). Używamy standardowego formatu do przechowywania całej statycznej dokumentacji klienta (dokumentacji licencji oprogramowania, dokumentacji zakupu itp.), Która jest dość oczywista.
Wraz z repozytorium SVN hostujemy również nasz e-mail. Wszystkie przychodzące / wychodzące wiadomości e-mail zostały zarchiwizowane, odkąd domena firmy zaczęła otrzymywać wiadomości e-mail. Jest dostępny jako dzienniki BSMTP dla partnerów w celach informacyjnych (i osobiście uważam, że jest to bezcenne). Sytuacja nigdy się nie pojawiła, ale wiem, że chętnie udzielilibyśmy klientowi dostępu do dzienników wszelkiej korespondencji do / od swoich pracowników, gdyby kiedykolwiek o to poprosili. Zapewnienie wewnętrznej komunikacji między partnerami byłoby trudniejsze, ponieważ moglibyśmy równie dobrze odwoływać się do wielu klientów w tym samym komunikacie. (Prawdopodobnie powinniśmy być w tym lepsi, ale nie byliśmy.)
Hasła są główną „brodawką” w naszym procesie. Używamy indywidualnych repozytoriów „Bezpiecznych hasłem” (z unikatowymi kombinacjami) dla każdego klienta, aby umożliwić udostępnienie bezpiecznego pliku klientowi. Przechowujemy hasła główne wszystkich bezpiecznych plików w innym bezpiecznym pliku, z kombinacją znaną tylko partnerom. Ta część naprawdę wymaga trochę pracy. Wydaje mi się, że chcielibyśmy, aby każdy Klient prowadził lokalny magazyn referencji przy użyciu prawdziwej aplikacji do przechowywania haseł dla wielu użytkowników (ze ścieżką audytu itp.), Ale od prawie 10 lat rzucamy ten pomysł na plażę .
Nasze rekordy śledzenia czasu są skrupulatnie szczegółowe i dostarczane Klientom w dowolnym formacie elektronicznym, jaki chcą (którym do tej pory był tekst ASCII i PDF). Klienci otrzymują godziny rozpoczęcia / zatrzymania każdego płatnego zdarzenia oraz pełny opis wykonanej pracy. Uważamy, że te uwagi serwisowe są bardzo cenne wewnętrznie, ponieważ pozwalają nam być na bieżąco z tym, co dzieje się w witrynach klientów partnerów. W przypadku problemu, zapisy te dostarczają nam wiedzy opartej na wszystkich wcześniejszych problemach i rozwiązaniach, które napotkaliśmy przez lata. Nie wstydzę się powiedzieć, że rozwiązałem problemy dla jednego klienta, znajdując notatki, o których przed laty zapomniałem pisać.
Odkładając na bok szybkie i ostrzegawcze: tworzenie dokumentacji: W mojej „starej pracy” (praca dla kogoś innego lata temu) firma wszczęła postępowanie prawne przeciwko nieopłacającemu klientowi. Skończyło się na tym, że po stronie biznesowej powstał pozew wzajemny od nieopłacającego klienta. Nasze wewnętrzne akta i e-maile dotyczące: tego, że klient został wezwany i wyłożony przed sądem. To doświadczenie nauczyło mnie wiele o tym, że nie przechowuję niczego na stałym nośniku, czego nie chcesz upubliczniać.
Napisałem kilka e-maili z niektórymi (erm) wyborowymi słowami i wyrażeniami na temat moich frustracji związanych z tym Klientem i niektórymi innymi „inżynierami” w mojej firmie. Konieczność przesłuchania w tych sprawach na posiedzeniu jawnym wcale nie sprawiała mi przyjemności.
Kiedy zaczynaliśmy naszą obecną działalność, partnerzy zgodzili się, że wszystkie stałe zapisy (e-mail, wiadomości tekstowe, poczta głosowa, pliki w repozytorium SVN, zapisy pracy w module do śledzenia czasu itp.) Będą przez cały czas uważane za „skierowane do klienta” - nawet jeśli nigdy nie miały one trafić do rąk Klientów. Było to trudne i wymaga dużej dyscypliny, ale myślę, że warto. Z pewnością chcemy zaoferować naszym klientom atmosferę profesjonalizmu, a życie w ten sposób jest tym sposobem. Na pewno nigdy się nie wstydzę, jakbym był ponownie w tej sali sądowej.