Doradztwo: Organizowanie dokumentacji witryny / środowiska dla klientów? [Zamknięte]

12

Z czasem zająłem się konsultingiem i inżynierią kontraktową dla różnych klientów. Ostatnio klienci proszą o określone rodzaje dokumentacji.

  • Z jakich statycznych adresów IP mogę korzystać w nowym sieciowym zegarze czasu, który instalujemy?
  • Jak umieścić wykluczenie w filtrze internetowym? Prezes nie może już wejść na stronę NRA !!
  • Musimy zamknąć serwer Linux na wypadek planowanej przerwy w dostawie prądu. Jakie jest to polecenie ponownie?

Są to małe firmy i zazwyczaj nie mają dedykowanego personelu technicznego. W ramach jednej firmy Wiki / Confluence / Sharepoint itp. Mają sens jako centralne repozytorium dokumentacji i informacji o środowisku, ale mam trudności ze znalezieniem spójnej metody dostarczania tych informacji dyskretnym klientom.

Kręcę proces, który jest bardziej przenośny, bezpieczny i elegancki niż prosty arkusz kalkulacyjny lub przerażający segregator pełen nieaktualnych informacji .

  • Ważne adresy IP, zakres DHCP itp.
  • Schemat sieci (w razie potrzeby).
  • Administracyjne nazwy użytkowników i hasła oraz adresy URL zarządzania.
  • Klucze licencyjne oprogramowania.
  • Umowy wsparcia i informacje gwarancyjne.
  • Kontakty i instrukcje pomocy technicznej dostawcy.

Wiem, że są tu inni konsultanci. Wszelkie sugestie lub wskazówki dotyczące przechowywania dokumentacji w wielu środowiskach w formacie przyjaznym dla klienta? Jak ty to robisz?

ewwhite
źródło

Odpowiedzi:

12

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.

Evan Anderson
źródło
1
Doskonała odpowiedź. Chociaż nie jestem konsultantem i pracuję tylko dla jednej dużej firmy, zgadzam się z większością rzeczy. Dodałbym, że baza danych zasobów, która zapełnia takie rzeczy jak DNS, monitorowanie, marionetka itp., Może być również dobra rzecz, ale nie przechowuj w niej informacji, których nie używasz, bo będą przestarzałe i będą bezużyteczny.
Dennis Kaarsemaker,
Jakiego oprogramowania używasz do generowania raportów na żywo? Co z takimi rzeczami, jak fizyczne lokalizacje, diody przełączania awaryjnego itp.?
Steve Butler,
@ SteveButler - Kiedy trochę się uwolnię, rozwinę to, o co prosisz, a także odniosę się do edycji pytania. Jest mnie mniej do poruszania się niż kiedykolwiek wcześniej ...> uśmiech <
Evan Anderson
2

Aby uzyskać podstawowe informacje, takie jak opisywane (z wyjątkiem diagramu sieciowego), korzystamy z jednego skoroszytu programu Excel i zapisujemy go w folderze sieciowym z nazwą klienta. Chociaż rozumiem, dlaczego ludzie nie lubią tego podejścia, uważam, że działa świetnie, ponieważ jest to pojedynczy dokument referencyjny, który mogę zabrać ze sobą na stronę, przesyłać pocztą e-mail i szybko aktualizować.

Moim największym zarzutem byłby brak kontroli wersji, ale wciąż nie znalazłem niczego, co działałoby dobrze, nie utrudniając życia.

Aby odeprzeć twój „Kręcę nad procesem, który jest bardziej przenośny, bezpieczny i elegancki niż prosty arkusz kalkulacyjny”:

Bardziej przenośny: Co może być bardziej przenośnego niż 500-kilobajtowy arkusz kalkulacyjny? Bałbym się używać czegokolwiek w chmurze lub w Internecie, ponieważ nie można zagwarantować łączności z Internetem.

Bezpieczny: ten, który ci dam i ja też chciałbym rozwiązań, które uczynią nasze rozwiązanie bezpieczniejszym.

Elegancki: spędziliśmy czas na tworzeniu ładnego szablonu dla naszego skoroszytu. Jak mówię, jest to skoroszyt na wiele arkuszy, a nie tylko duża strona rozproszonych informacji. Myślę, że większość dokumentacji IT ładnie pasuje do tabeli, a arkusz kalkulacyjny sprawia, że ​​jest to bardzo schludne i proste.

Chociaż mam wiele problemów z tym, jak rejestrujemy i przechowujemy dokumentację kompilacji, naprawdę nie mogę znaleźć błędu w solidnym, dobrze sformatowanym arkuszu kalkulacyjnym. Dodam też, że współpracujemy z niektórymi dużymi firmami świadczącymi usługi IT i działają one w ten sam sposób. Znowu jest genialny - przychodzę na stronę, żądam dokumentacji i otrzymuję pojedynczy schludny arkusz kalkulacyjny, którego mogę używać przez cały czas.

Dan
źródło
2

Dużą zaletą tego przerażającego spoiwa jest:

  • Klienci nietechniczni mogą to zrozumieć, zachować ją na miejscu i zapewnić bezpieczeństwo, tak jak są przyzwyczajeni i już robią z wszelkiego rodzaju innymi ważnymi formalnościami.
  • Twoi klienci mogą go z łatwością przekazać na wypadek, gdyby wynajął dla ciebie zamiennik, profesjonalną rzecz do zrobienia i coś, co dałoby ci szybki start i referencje, kiedy dostałeś ich jako klientów.
  • Prosty dziennik konserwacji na początku z najważniejszymi punktami każdej wizyty na stronie jest czymś konkretnym.
  • Spoiwo posiada również płyty CD / DVD i certyfikaty z kodami licencji i kluczami aktywacyjnymi na wypadek wizyty BSA lub innego dostawcy.

Jakikolwiek system cyfrowy, którego używasz, tak naprawdę nie ma już znaczenia, o ile tylko zdyscyplinujesz się, aby aktualizować segregator za każdym razem, gdy zrobisz coś wartościowego.

A spoiwo jest oczywiście całkowicie bezużyteczne, jeśli wykonujesz prawie całe wsparcie zdalnie.

Byłem wielkim fanem używania wiki, ponieważ jest łatwa w utrzymaniu, łatwo można śledzić hiperłącza do ILO i interfejsów zarządzania, zdalnego pulpitu i logowania SSH. Swobodny format pasuje do większości informacji, które chciałbym mieć:

  • opis strony: „drukarka sieciowa (OKI 1234 MFP) jest obok biurka Johna, drukarka atramentowa HP model 0123 siedzi w Bobs, biuro szefa” znacznie ułatwia odbieranie połączeń telefonicznych: „mamy zabrakło atramentu, jaki wkład należy zamówić ponownie? ”.

  • strona dla każdego urządzenia, najlepiej ze zdjęciem, typem i konfiguracją, przeznaczeniem itp.

  • Istnieje kilka przyzwoitych modułów eksportu dla Wiki do generowania papierowych lub cyfrowych dokumentów do przekazania i włączenia do tego przerażającego spoiwa

HBruijn
źródło
Słuszne uwagi. Jestem zdalny dla 90% moich klientów, ale często podróżuję. Czy zasugerowałbyś centralne wiki, które hostuję, a nie coś lokalnego?
ewwhite
Gdy hostujesz wiki, znacznie łatwiej jest skonfigurować synchronizację z laptopem, co wydaje się rozsądne, gdy często podróżujesz.
HBruijn,
0

Zgadzam się z Danem, że Excel jest dobrym, przenośnym rozwiązaniem i myślę, że jest to doskonały argument, z wyjątkiem części dotyczącej bezpieczeństwa, w której moim zdaniem obawy są nieco źle skierowane:

Niezależnie od tego, jaką metodą chcesz rozpowszechniać, można objąć bezpieczne rozwiązanie (np. Zaszyfrowane wiadomości e-mail, zabezpieczone współdzielone przechowywanie itp.). To samo dotyczy kontroli wersji (np. Kopie w tle, svn itp.).

Jednak tylko w ramach konstruktywnej krytyki i z całym szacunkiem dodam, że poważnym minusem wspólnego arkusza kalkulacyjnego Excel są jego ograniczenia współbieżności. W dniu, w którym masz dwóch lub więcej administratorów, uznają, że zmuszenie ich do wyboru między otwarciem arkusza w celu edycji lub zapisaniem wielu kopii, które następnie wymagają scalenia, jest jednym z głównych problemów. aktualne, a które nie?). I to naprawdę jest ból.

Lepszym rozwiązaniem jest użycie programu Excel (lub cokolwiek zechcesz) jako nakładki na małą bazę danych do wyboru, czy to Access (tylko w celu rozwiązania kwestii przenośności), MS SQL, MariaDB lub cokolwiek innego.

Opowiadam się za tym rozwiązaniem, które nie tylko nadaje się do przekazywania informacji innej stronie (= Excel), ale nadaje się również do utrzymania ciągłej dokumentacji.

Krótko mówiąc, moim zdaniem, nawet z kilkoma administratorami (nie wspominając o większych sklepach), dział polegający na Excelu do przechowywania danych dokumentacji jest działem z rozległą dokumentacją. Nigdy nie widziałem wyjątku, chyba że jest tylko jeden administrator.

Ale dział korzystający z pamięci masowej opartej na bazie danych ma możliwość przechowywania ścisłej, aktualnej dokumentacji. To tylko kwestia wysiłku. Excel jest wykonalnym front-dbem z zaletami i wadami, ale nie jest jedyną opcją.

ErikE
źródło
Przypomnij sobie, że dotyczy to sytuacji konsultacyjnej z wieloma klientami. Nie będzie żadnych problemów z współbieżnością.
ewwhite
0

To może nie być to, czego szukasz, ale oto co robię.

Korzystam z pakietu Microsoft Office, aby tworzyć wszystkie dokumenty dla każdego z moich klientów. Używam Excela (informacje o adresie IP, mapowanie portów przełącznika, układ szafy), Worda (informacje o konfiguracji, faktury, szablony SOW) i Visio (diagramy). Tworzę hierarchię folderów z folderem nadrzędnym o nazwie Consulting i folderem podrzędnym o nazwie dla każdego klienta. Kiedy tworzę lub aktualizuję dokumenty klienta, synchronizuję je z moim iPhonem (za pomocą Documents To Go ), napędem USB i kontem DropBox (z użyciem uwierzytelniania dwuskładnikowego). W ten sposób mam dostęp do całej dokumentacji (w taki czy inny sposób), gdziekolwiek i gdziekolwiek się udam.

Korzystam również z aplikacji do zarządzania projektami / raportowania / fakturowania / śledzenia czasu o nazwie OfficeTime . Istnieje aplikacja na iPhone'a i towarzysząca jej aplikacja Windows, więc mam dostęp do informacji o projekcie, fakturowaniu, godzinach itp. Na moim iPhonie, gdy jestem na stronie, i synchronizuję się z komputerem, gdy wrócę do domu.

joeqwerty
źródło
0

Chociaż nie jest to idealne rozwiązanie, ale powinieneś spojrzeć na Device42 .

Oto, co możesz zrobić: adresy IP i urządzenia mogą być powiązane z klientami. I możesz mieć grupy VRF do nakładania się zakresów adresów IP u różnych klientów.

Nie ma szczegółowego pozwolenia na adresy IP / urządzenia (tylko globalny dostęp oparty na rolach), więc nie możesz pozwolić klientom końcowym na bezpośredni dostęp. Możesz jednak tworzyć raporty dla klientów z informacjami o urządzeniu i adresie IP i wysyłać je do klienta końcowego, gdy jest to wymagane.

To przynajmniej da ci interfejs do uporządkowania wszystkich informacji w centralnym repozytorium. Możesz przechowywać informacje o zasobach, informacje o adresie IP, informacje o umowie i hasła.

Zapewnia także większość informacji w wywołaniach interfejsu API REST, ale nie jestem pewien, czy na tej podstawie można coś połączyć dla poszczególnych klientów.

Sonu Bansal
źródło
To nie do końca pasuje, ale interesująca platforma zarządzania zasobami dla większych środowisk.
ewwhite
1
Zgadzam się, nie idealne dopasowanie do twoich potrzeb. Wysłałem do nich żądanie funkcji, aby dodać dostęp oparty na rolach również na podstawie klientów. Dla nas, dostawców usług w chmurze, dobrze jest śledzić cały sprzęt klienta i adresy IP, ale chcielibyśmy również dać klientom dostęp do portalu, aby mogli sami uzyskać dostęp do swoich informacji.
Sonu Bansal