Consulting: Site- / Umgebungsdokumentation für Kunden organisieren? [geschlossen]


12

Im Laufe der Zeit habe ich Beratungs- und Auftragsarbeiten für verschiedene Kunden übernommen. In jüngerer Zeit fragen Kunden nach bestimmten Dokumentationsarten.

  • Welche statischen IP-Adressen kann ich für die neue Netzwerkzeituhr verwenden, die wir installieren?
  • Wie füge ich einen Ausschluss in den Webfilter ein? Der CEO kann die NRA-Website nicht mehr aufrufen !!
  • Wir müssen den Linux-Server für einen geplanten Stromausfall herunterfahren. Was ist der Befehl nochmal?

Dies sind kleine Unternehmen, für die in der Regel kein spezielles technisches Personal zur Verfügung steht. Innerhalb eines einzigen Unternehmens sind Wiki / Confluence / Sharepoint usw. alle als zentrales Repository für Dokumentations- und Umgebungsinformationen sinnvoll, aber ich finde keine einheitliche Methode, um diese Informationen an diskrete Kunden zu liefern .

Ich mache Aufnahmen für einen Prozess, der portabler, sicherer und eleganter ist als eine einfache Tabelle oder der gefürchtete Ordner voller veralteter Informationen .

  • Wichtige IP-Adressen, DHCP-Bereich usw.
  • Netzwerkdiagramm (falls erforderlich).
  • Administrative Benutzernamen und Kennwörter sowie Verwaltungs-URLs.
  • Software-Lizenzschlüssel.
  • Supportverträge und Garantieinformationen.
  • Support-Kontakte und Anweisungen des Herstellers.

Ich weiß, dass es hier noch andere Berater gibt. Haben Sie Vorschläge oder Tipps zur Pflege der Dokumentation in mehreren Umgebungen in einem kundenfreundlichen Format? Wie machst du das

Antworten:


12

Ich bin seit Juni 2004 Partner in einem Drei-Personen-Vertrags- / Beratungsdienst. Wir arbeiten jeweils hauptsächlich mit unseren eigenen "Konten". Wir müssen jedoch gegenseitig Unterlagen führen, um ein "Failover" zwischen Partnern zu ermöglichen. Die meisten unserer Kunden verfügen über interne IT-Mitarbeiter, von denen viele eine gewisse tägliche Wartung durchführen, und wir müssen ihnen auch die Dokumentation effektiv übermitteln.

Meine beiden Partner haben den Vorteil (wenn Sie das so nennen können), als Angestellte bei einem anderen Unternehmen gearbeitet zu haben, und wurden daher beide auf meine einfühlsame Art und Weise unterwiesen. Die strikte Übereinstimmung (wo es offensichtlich sein kann) zwischen den Konfigurationen der Kunden ist ein Glücksfall. Offensichtlich ändern sich die Produkte, so dass wir uns treffen, um neue Produkte / Versionen usw. zu besprechen und eine konsistente Konfigurationsstrategie festzulegen, bevor wir sie bereitstellen. Dies würde sich nicht auf ein großes Unternehmen auswirken, aber ehrlich gesagt sehe ich das eher als ein Feature als als einen Bug. (Ich werde nicht anfangen, über größere "Managed Services" -Unternehmen mit ihren Angestellten "Ingenieuren" und schrecklichen Tendenzen zu Unikaten, halbherzigen "Lösungen" und Inkonsistenzen zwischen Kunden zu schimpfen ...> smile <)

Ich bin heftig gegen "den gefürchteten Binder". Ich habe noch nie gesehen, dass die physische Dokumentation auf dem neuesten Stand war . Ich denke, es ist Geldverschwendung des Kunden, Zeit damit zu verbringen, physische Kopien der Dokumentation anzufertigen. Ich würde viel lieber Zeit damit verbringen, herauszufinden, wie man Dokumentation basierend auf "Live" -Daten aus laufenden Konfigurationen generiert.

Beispielsweise werde ich auf keinen Fall Tabellen mit IP-Adressinformationen verwalten. Dafür gibt es DHCP und DNS (Einzelheiten siehe unten). Wenn diese Dinge nicht funktionieren, haben wir große Probleme.

Wir haben Kunden aufgefordert, Dinge wie "ein Dokument zu erstellen, in dem alle unsere Gruppenrichtlinienkonfigurationen aufgeführt sind", und ich habe mich in meine Fersen eingegraben und mich geweigert, dies zu tun. Mein immer wiederkehrender Gegenvorschlag (der bis jetzt funktioniert hat) war, den Kunden mit Verwaltungstools bekannt zu machen, mit denen er sich selbst bedienen oder mit Hilfe von Software auf Abruf "live" kundenfreundliche Dokumentationen erstellen kann.

Wir sind sehr bemüht, die Dinge in einfachem Englisch zu buchstabieren. Ein nicht technischer IT-Kontakt kann beispielsweise die Active Directory-Gruppenmitgliedschaft eines Computers überprüfen und Informationen wie "Software - Microsoft Office 2010 Pro installieren" und "Gruppenrichtlinie - Automatische Anmeldung für Kioskcomputer" anzeigen. Es bedarf keiner Dokumentation, um zu erklären, was diese Dinge bedeuten.

Hier sind einige "Live" -Daten, die wir verwenden:

  • Die gesamte IP-Adresszuweisung wird auf DHCP-Servern gespeichert. Dies gilt auch für Geräte mit statischer Adresse (in den Kommentaren als solche gekennzeichnet). MAC- und IP-Adressen können einfach per Skript oder manuell abgefragt werden, und die Daten müssen per Definition auf dem neuesten Stand sein, wenn sie in der Produktion verwendet werden.

  • Alles bekommt einen Namen und einen PTR-Eintrag im DNS. Die meisten Hosts erhalten auch einen HINFO-Record. Dinge, die ausführliche Beschreibungen benötigen, erhalten einen TXT-Datensatz.

  • Reichliche und ausführliche Verwendung von "Notizen" -Feldern, wo immer dies möglich ist - Active Directory, Computerbeschreibungen, Beschreibungen freigegebener Ordner usw. Wir sind auch ausführlich und verständlich in Bezug auf Sicherheitsgruppennamen.

  • Kommentare / Anmerkungen in Netzwerk-Gear-Konfigurationen (Kommentare zu ACLs, Beschreibungen zu Ports, SNMP-Standort / Kontaktinformationen zum Beispiel).

Ich bin ziemlich negativ auf die Idee der Freiform-Informationsspeicherung in Dingen wie Textdateien, Wikis usw. Struktur sorgt für eine gute Suche. Wann immer ich einen strukturierten Speichermechanismus für mich arbeiten lassen kann (auch wenn dies bedeutet, dass ich Software schreiben muss, um ihn abzufragen), bevorzuge ich ihn. Kommentare, die ich aus Konfigurationsdateien, Datenbanken usw. analysieren kann, überzeugen mich immer dann, wenn sie mit manuell erstellten Dokumenten verglichen werden, die fast sofort veraltet sind.

Wenn wir "Freiform" -Informationen speichern müssen, verwenden wir unser eigenes SVN-Repository. Es enthält alle statischen Dokumente, die wir im Laufe der Jahre erstellt haben und die vom Kunden eingereicht wurden. Wir verwenden SVN dafür seit 2004 und es hat sich als Kollaborationswerkzeug für uns sehr gut bewährt. Wir versionieren Datenbankschemata, Sysadmin-Skripte, Gruppenrichtlinienobjekt-Sicherungen usw. Ich versuche, alles, was ich kann, in die Versionskontrolle einzuchecken.

Es ist sehr einfach, meine Kasse mit dateisystembasierten Indizierungswerkzeugen zu durchsuchen. Ich weiß, dass jeder von uns jederzeit vor Ort mindestens eine vollständige Kopie des Repository zur Verfügung hat. Wir haben das Repository auch über authentifiziertes WebDAV über SSL zugänglich gemacht, falls wir unbedingt auf dort gespeicherte Daten zugreifen müssen und nur über Browserzugriff verfügen.

Wir wurden noch nie darum gebeten, aber wir würden uns freuen, ein Konto auf dem SVN-Server einzurichten, mit dem ein Kunde auschecken und mit seinen eigenen Dateien interagieren kann (sofern er über eine interne Ressource verfügt, die dazu bereit ist) ). Wir verwenden ein standardisiertes Format zum Speichern der gesamten statischen Kundendokumentation (Softwarelizenzdokumentation, Kaufdatensätze usw.), die ziemlich selbsterklärend ist.

Zusammen mit dem SVN-Repository hosten wir unsere E-Mails selbst. Alle eingehenden / ausgehenden E-Mails wurden archiviert, seit die Domäne des Unternehmens E-Mails empfängt. Es ist als BSMTP-Protokoll für die Partner als Referenz verfügbar (und ich persönlich fand es von unschätzbarem Wert). Die Situation hat sich nie ergeben, aber ich weiß, dass wir einem Kunden gerne Zugriff auf die Protokolle der Korrespondenz mit / von seinen Mitarbeitern gewähren würden, wenn er jemals danach fragt. Die Einrichtung einer internen Kommunikation zwischen den Partnern wäre schwieriger, da wir möglicherweise mehrere Kunden in derselben Nachricht referenzieren. (Wir sollten das wahrscheinlich besser machen, haben es aber nicht getan.)

Passwörter sind eine wichtige "Warze" in unserem Prozess. Wir verwenden für jeden Kunden individuelle "Password Safe" -Repositorys (mit eindeutigen Kombinationen), damit die sichere Datei für den Kunden freigegeben werden kann. Wir speichern die Hauptkennwörter für alle sicheren Dateien in einer anderen sicheren Datei. Eine Kombination, die nur den Partnern bekannt ist. Dieser Teil braucht wirklich etwas Arbeit. Ich denke, wir möchten, dass jeder Kunde einen Vor-Ort-Tresor für Anmeldeinformationen unter Verwendung einer echten Mehrbenutzer-Tresoranwendung für Kennwörter (mit einem Audit-Trail usw.) hostet, aber wir haben diese Idee seit fast 10 Jahren auf den Markt gebracht .

Unsere Zeiterfassungen werden akribisch detailliert und den Kunden in jedem gewünschten elektronischen Format (bisher ASCII-Text und PDF) zur Verfügung gestellt. Kunden erhalten Start / Stopp-Zeiten für jedes abrechenbare Ereignis und eine ausführliche Beschreibung der durchgeführten Arbeiten. Wir halten diese Servicemitteilungen intern für sehr wertvoll, da sie es uns ermöglichen, auf dem Laufenden zu bleiben, was bei den Kunden der Partner vor sich geht. Im Falle eines Problems geben uns diese Aufzeichnungen einen Überblick über alle früheren Probleme und Lösungen, auf die wir im Laufe der Jahre gestoßen sind. Ich schäme mich nicht zu sagen, dass ich Probleme für einen Kunden gelöst habe, indem ich Notizen gefunden habe, die ich vor Jahren vergessen habe, für einen anderen Kunden zu schreiben.


Abgesehen von einer schnellen und vorsichtigen Überprüfung der Erstellung von Unterlagen: Bei meinem "alten Job" (der vor Jahren für jemanden gearbeitet hat) hat das Unternehmen eine Klage gegen einen nicht zahlenden Kunden eingereicht. Wir waren am Geschäftsende einer Gegenklage des nicht zahlenden Kunden. Unsere internen Unterlagen und E-Mails betrafen: dass der Kunde vor Gericht vorgeladen und entblößt wurde. Diese Erfahrung hat mich sehr gelehrt, nichts auf einem festen Medium zu speichern, das nicht veröffentlicht werden soll.

Ich hatte ein paar E - Mails mit einigen (ERM) geschrieben Wahl Wörter und Sätze in ihnen über meine Frustrationen mit diesen Kunden und mit einigen der anderen „Ingenieure“ in meinem Unternehmen. Ich habe es überhaupt nicht genossen, vor Gericht über diese Dinge verhört zu werden.

Als wir unser jetziges Geschäft aufnahmen, waren sich die Partner einig, dass alle festen Aufzeichnungen (E-Mail, Textnachrichten, Voicemail, Dateien im SVN-Repository, Arbeitsaufzeichnungen im Zeiterfassungsprogramm usw.) immer als "kundenorientiert" gelten - sogar wenn sie niemals in die Hände der Kunden gelangen sollten. Das war schwierig und erfordert viel Disziplin, aber ich denke, es lohnt sich. Wir möchten unseren Kunden einen Hauch von Professionalität vermitteln, und so zu leben ist der Weg, dies zu tun. Ich werde mich bestimmt nie wieder so schämen, wie ich in diesem Gerichtssaal war.


1
Hervorragende Antwort. Obwohl ich kein Berater bin und nur für ein großes Unternehmen arbeite, stimme ich den meisten Dingen zu. Ich würde hinzufügen, dass eine Asset-Datenbank, die Dinge wie DNS, Überwachung, Marionette usw. auffüllt, auch eine gute Sache sein kann, aber keine Informationen darin speichert, die Sie nicht verwenden, oder sie wird veraltet sein und veralten nutzlos.
Dennis Kaarsemaker

Welche Art von Software verwenden Sie, um diese Live-Berichte zu erstellen? Was ist mit Dingen wie physischen Standorten, Failover-Diagrammen usw.?
Steve Butler

@SteveButler - Wenn ich ein bisschen frei bin, werde ich näher auf Ihre Fragen eingehen und die Bearbeitung der Frage erläutern. Es gibt weniger von mir zu
Evan Anderson

2

Für Kerninformationen, wie Sie sie beschreiben (mit Ausnahme eines Netzwerkdiagramms), verwenden wir eine einzelne Excel-Arbeitsmappe und speichern diese in einem Netzwerkordner mit dem Namen des Kunden. Obwohl ich verstehen kann, warum die Leute diesen Ansatz nicht mögen, finde ich, dass er großartig funktioniert, da es sich um ein einzelnes Referenzdokument handelt, das ich zur Website mitnehmen, per E-Mail weiterleiten und schnell aktualisieren kann.

Meine größte Beschwerde wäre ein Mangel an Versionskontrolle, aber ich muss noch etwas finden, das gut funktioniert, ohne das Leben schwer zu machen.

Um Ihrer Aussage entgegenzuwirken, dass "ich einen Prozess anstrebe, der portabler, sicherer und eleganter ist als eine einfache Tabelle":

Portabler: Was kann portabler sein als eine 500-Kilobyte-Tabelle? Ich hätte Angst davor, Clouds oder webbasierte Lösungen zu verwenden, da die Internetverbindung nicht garantiert werden kann.

Sicher: Diesen möchte ich Ihnen geben, und auch ich hätte gerne Lösungen, um unsere Lösung sicherer zu machen.

Elegant: Wir haben viel Zeit damit verbracht, eine schöne Vorlage für unsere Arbeitsmappe zu erstellen. Wie ich bereits sagte, ist dies eine mehrblättrige Arbeitsmappe, nicht nur eine riesige Seite mit verstreuten Informationen. Ich denke, die meisten IT-Dokumente passen gut in eine tabellarische Form und eine Tabellenkalkulation hält dies sehr ordentlich und einfach.

Obwohl ich viele Probleme damit habe, wie wir Build-Dokumentation aufzeichnen und speichern, kann ich in einer soliden, gut formatierten Tabelle wirklich keinen Fehler finden. Ich möchte auch hinzufügen, dass wir mit einigen großen IT-Dienstleistungsunternehmen zusammenarbeiten, und diese arbeiten auf die gleiche Weise. Wiederum ist es großartig - ich komme auf die Website, fordere die Dokumentation an und erhalte eine einzige übersichtliche Tabelle, die ich für die Dauer verwenden kann.


2

Der große Vorteil dieses gefürchteten Bindemittels ist:

  • Nicht-technische Kunden können es verstehen, es vor Ort aufbewahren und es sicher aufbewahren, wie sie es gewohnt sind und bereits mit allen anderen wichtigen Dokumenten zu tun haben.
  • Ihre Kunden können es einfach übergeben, falls sie einen Ersatz für Sie einstellen, eine professionelle Sache, die Sie erledigt haben und die Ihnen einen schnellen Einstieg und eine schnelle Referenz gegeben hätte, als Sie sie als Kunden gelandet haben.
  • Ein einfaches Wartungsprotokoll am Anfang mit den Höhepunkten jedes Besuchs vor Ort ist etwas Greifbares.
  • Der Ordner enthält auch CDs / DVDs und Zertifikate mit Lizenzcodes und Aktivierungsschlüsseln für den Fall, dass die BSA oder ein anderer Anbieter zu Besuch kommt.

Welches digitale System Sie auch verwenden, spielt keine Rolle mehr, solange Sie sich disziplinieren, den Ordner zu aktualisieren, wenn Sie etwas getan haben, das sich lohnt.

Und der Ordner ist für Sie natürlich völlig nutzlos, wenn Sie fast Ihre gesamte Unterstützung aus der Ferne erledigen.

Ich war ein großer Fan der Verwendung eines Wikis, da es leicht zu pflegen ist, Hyperlinks zu ILO- und Verwaltungsoberflächen, Remotedesktop- und SSH-Anmeldungen leicht zu verfolgen sind. Die Freiform passt zu den meisten Informationen, die ich haben möchte:

  • Beschreibung der Website: "Der Netzwerkdrucker (OKI 1234 MFP) befindet sich neben Johns Schreibtisch, der HP-Tintenstrahldrucker Modell 0123 befindet sich in Bobs, dem Büro des Chefs." die Tinte ausgeht, welche Patrone sollen wir noch einmal bestellen?

  • Seite für jedes Gerät, idealerweise mit Bild, Typ und Konfiguration, Zweck usw.

  • Es gibt einige anständige Exportmodule für Wikis, um Hardcopy- oder digitale Dokumente für die Übergabe und Aufnahme in diesen gefürchteten Ordner zu erstellen


Gute Argumente. Ich bin zu 90% von meinen Kunden entfernt, reise aber oft. Würden Sie ein zentrales Wiki vorschlagen, das ich hoste, und etwas, das sich vor Ort befindet?
Ewwhite

Wenn Sie das Wiki hosten, ist es viel einfacher, es so einzurichten, dass es mit Ihrem Laptop synchronisiert wird, was bei häufigen Reisen vernünftig erscheint.
HBruijn

0

Ich bin damit einverstanden, dass Dan in Bezug auf Excel eine gute, tragbare Lösung ist, und ich denke, dass er ein hervorragendes Argument dafür ist, mit Ausnahme des Sicherheitsteils, bei dem meiner Meinung nach die Bedenken etwas fehlgeleitet werden:

Unabhängig von der Methode, mit der verbreitet werden soll, kann eine sichere Lösung abgedeckt werden (z. B. verschlüsselte E-Mail, gesicherter gemeinsamer Speicher usw.). Das gleiche gilt für die Versionskontrolle (z. B. Schattenkopien, SVN usw.).

Zur konstruktiven Kritik und bei allem Respekt möchte ich jedoch hinzufügen, dass der Hauptnachteil einer gemeinsam genutzten Excel-Tabelle die gleichzeitigen Einschränkungen sind. An dem Tag, an dem Sie zwei oder mehr Administratoren haben, wird es Ihnen schwerfallen, die Wahl zu treffen, entweder nur jeweils einen zur Bearbeitung des Arbeitsblatts zu öffnen oder mehrere Kopien zu speichern, die dann zusammengeführt werden müssen (welche Daten sind das?) aktuell und welche nicht?). Und es ist wirklich ein Schmerz.

Eine bessere Lösung ist, Excel (oder was auch immer Sie wünschen) als Frontend für eine kleine Datenbank Ihrer Wahl zu verwenden, sei es Access (nur um die Portabilität zu regeln), MS SQL, MariaDB oder was auch immer Sie möchten.

Ich befürworte dies als eine Lösung, die nicht nur geeignet ist, Informationen an eine andere Partei weiterzugeben (= Excel), sondern auch geeignet ist, den Aufwand für die fortlaufende Dokumentation aufrechtzuerhalten.

Kurz gesagt, meine Meinung ist, dass selbst mit wenigen Administratoren (von größeren Shops ganz zu schweigen) eine Abteilung, die sich bei der Speicherung von Dokumentationsdaten auf Excel verlässt, eine Abteilung mit einer umfangreichen Dokumentation ist. Noch nie eine Ausnahme gesehen, es sei denn, es gibt nur einen Administrator.

Eine Abteilung, die datenbankgesteuerten Speicher verwendet, hat jedoch die Möglichkeit, eine enge, aktuelle Dokumentation zu führen. Es ist dann nur eine Frage der Anstrengung. Ein Excel ist ein funktionsfähiges Datenbank-Frontend mit Vor- und Nachteilen, aber keineswegs die einzige Option.


Denken Sie daran, dass dies für eine Beratungssituation mit mehreren Kunden gilt. Es wird keine Probleme mit der Parallelität geben.
ewwhite

0

Das ist vielleicht nicht ganz das, wonach Sie suchen, aber hier ist, was ich tue.

Ich verwende Microsoft Office, um alle Dokumente für jeden meiner Kunden zu erstellen. Ich verwende Excel (IP-Adressinformationen, Switch-Port-Zuordnung, Rack-Layout), Word (Konfigurationsinformationen, Rechnungen, SOW-Vorlagen) und Visio (Diagramme). Ich erstelle eine Ordnerhierarchie mit dem übergeordneten Ordner Consulting und einem untergeordneten Ordner für jeden Client. Wenn ich Client-Dokumente erstelle oder aktualisiere, synchronisiere ich sie mit meinem iPhone (mithilfe von Documents To Go ), dem USB-Stick und dem DropBox-Konto (mithilfe der Zwei-Faktor-Authentifizierung). Auf diese Weise habe ich überall und überall Zugriff auf die gesamte Dokumentation (auf die eine oder andere Weise).

Ich verwende auch eine Projektmanagement- / Berichts- / Fakturierungs- / Zeiterfassungs- App namens OfficeTime . Es gibt eine iPhone-App und eine Windows-Begleit-App, sodass ich auf meinem iPhone Zugriff auf Projektinformationen, Rechnungen, Stunden usw. habe, wenn ich vor Ort bin, und wenn ich zu Hause bin, mit meinem Desktop synchronisiere.


0

Dies ist zwar keine perfekte Lösung, aber Sie sollten einen Blick auf Device42 werfen .

Folgendes können Sie tun: IPs und Geräte können Kunden zugeordnet werden. Sie können VRF-Gruppen für überlappende IP-Bereiche für verschiedene Kunden einrichten.

Es hat keine granulare Berechtigung für IPs / Geräte (nur globaler rollenbasierter Zugriff), daher können Sie Endkunden keinen direkten Zugriff gewähren. Sie können jedoch Berichte pro Kunde mit Geräte- und IP-Informationen erstellen und diese bei Bedarf an den Endkunden senden.

Auf diese Weise erhalten Sie zumindest eine Schnittstelle, über die Sie alle Informationen in einem zentralen Repository organisieren können. Sie können Asset-Informationen, IP-Informationen, Vertragsinformationen und Kennwörter speichern.

Außerdem bietet es die meisten Informationen in REST-API-Aufrufen, ist sich jedoch nicht sicher, ob Sie für einzelne Kunden auf dieser Grundlage eine Verbindung herstellen können.


Es ist nicht ganz passend, aber eine interessante Asset-Management-Plattform für größere Umgebungen.
Ewwhite

1
Stimmen Sie zu, keine perfekte Anpassung an Ihre Bedürfnisse. Ich habe ihnen eine Funktionsanforderung gesendet, um den rollenbasierten Zugriff auch auf Kundenbasis hinzuzufügen. Für uns als Cloud-Service-Provider ist es gut, alle Geräte und IP-Adressen unserer Kunden im Auge zu behalten. Wir möchten unseren Kunden jedoch auch Portalzugriff gewähren, damit sie selbst auf ihre Daten zugreifen können.
Sonu Bansal
Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.