Wäre Ihre Firma in Schwierigkeiten, wenn Sie von einem Bus angefahren würden?

Bei der Arbeit bin ich der einzige IT-Mann (mache alles und schreibe jetzt) ​​seit 10 Jahren. Wenn ich jemals von einem Bus angefahren würde, wären sie total durcheinander. Ich habe es mehrmals vor Führungskräften / Präsidenten erwähnt, aber sie ignorieren mich. Schade für sie.

Was kann ich tun, um ihre Schmerzen zu lindern? (Oder sollte es mich überhaupt interessieren?)

(Ja, dies sollte ein Community-Wiki sein, aber ich sehe das Kontrollkästchen nicht ... vielleicht habe ich nicht genug Repräsentanten.)

Dokumentieren Sie den Teufel aus allem heraus.

Vor kurzem gab es auf Slashdot einen Thread zum Starten der Dokumentation, der mich dazu inspirierte, meine Gedanken zur Dokumentation niederzuschreiben.

Meine wichtigsten Punkte waren:

Prinzip Nr. 1: Es wird niemals getan

Die Dokumentation ist ein ständiger Aufwand, der immer hinter dem zurückbleibt, was in der Produktion ist. Änderungen werden ad-hoc vorgenommen, Dinge verschoben oder eingestellt oder nach dem Zufallsprinzip in Betrieb genommen. Dokumentation wird nie aufholen.

Sie müssen den Rechnungszahlern den Wert der Zeit (und damit des Geldes) für die Aktualisierung der laufenden Dokumentation verkaufen. Häufig lauten diese Unterhaltungen wie folgt: "Erinnerst du dich, als ich $ TIME damit verbringen musste, herauszufinden, wie $ THING kaputt war? Nun, als ich fertig war, gab es diese technische Notiz, in der $ THING genau beschrieben wurde, damit der nächste Kerl nicht mitkommt Ich muss alles herausfinden. "

Sie müssen es tun, obwohl Sie nie fertig werden.

Prinzip 2: Die einzige Sache, die schlimmer ist als keine Dokumentation, ist die falsche Dokumentation

Dies ist eher eine Binsenweisheit als ein Prinzip. Die Dokumentation kann Sie in den falschen Sinn wiegen, dass sich etwas in einem bekannten Zustand befindet, und dass Sie, wenn etwas schief geht, sofort damit beginnen können, es zu beheben.

Es ist wichtig, dieses Problem anzuerkennen.

Prinzip 3: Sie schreiben eine Dokumentation für Ihren Nachfolger

Die Wahrscheinlichkeit ist 95% von allem, was Sie dokumentieren, worauf Sie sich nie wieder beziehen müssen. Dokumentation ist eine Sammlung von Weisheiten für die Zukunft, nicht für Sie. Sie müssen also davon ausgehen, dass Ihr Publikum nur wenig oder gar nichts über die Besonderheiten weiß, wie die Dinge so sind, wie sie sind.

Und es wird einen Nachfolger geben. Ich weiß nichts über dich, aber ich habe nicht vor, für den Rest meines Lebens in diesen speziellen Umgebungen zu sein. Gelegenheiten kommen und gehen, und wenn sie kommen, gehst du manchmal. Aber das Leben geht hinter dir weiter, und je ruhiger du für deinen Nachfolger leben kannst, desto besser. Andernfalls könnten Sie eine Ansammlung ehemaliger Kunden haben, die leise schmeichelhafte Dinge über Sie sagen. Ich möchte sagen, dass es die gleichen 50 Leute sind, die überall in der IT in Ottawa arbeiten, weil man ihnen überall begegnet. Wenn Sie Ihrem Nachfolger helfen, können Sie in Zukunft möglicherweise Türen öffnen.

Bis zu einem gewissen Grad gibt es immer ein gewisses Maß an "Schuld dem Vorgänger", wenn Probleme auftauchen. Das gehört zum Geschäft. Ich habe es selbst gemacht. Aber bei mehreren Gelegenheiten, als ich den vorherigen Typen als eine Art Idioten verprügelt hatte, habe ich ansonsten erfahren, dass er wirklich seine Tat zusammen hatte und mehr über das wusste, was los war, als ich es damals tat.

Prinzip 4: "Warum" ist oft wichtiger als "Wie"

Wenn die meisten von uns ein System betrachten, denken sie, warum zum Teufel ist das so? Es gibt fast immer sehr spezifische Gründe für die getroffenen Konfigurationsentscheidungen. Unter diesen Umständen gibt das "Warum" das "Wie" vor und Sie müssen sicherstellen, dass der Leser die spezifischen Probleme versteht, die bei der Untersuchung der Rauchreste Ihrer Lösung gelöst werden.

Prinzip # 5: Es muss einfach sein oder du wirst es nicht tun

Dies bedeutet, dass Sie sich Ihrer Werkzeuge sowie derer, die Ihre Werkzeuge verwenden, sehr bewusst sein müssen.

Es muss einfach sein, die Dinge auf dem neuesten Stand zu halten. Wenn Sie sich anstrengen müssen, werden Sie Ausreden finden, um dies zu vermeiden, wenn es am besten ist, was unmittelbar nach einer Änderung der Fall ist.

Wenn Ihre Werkzeuge für andere nicht einfach zu verwenden sind, werden sie sie nicht verwenden. Dies kann in einer Teamumgebung besonders lähmend sein, da je größer das Team ist, desto wahrscheinlicher ist es, dass Sie auf ein Teammitglied treffen, das Ihre Werkzeugauswahl nicht mag.

Persönlich mag ich ein Wiki für Dokumente. Das Problem ist jedoch, dass ein Wiki Ihnen keine Struktur aufzwingt, sodass die Struktur von außen auferlegt werden muss. Dies führt immer irgendwo zu Konflikten, da jemand anderes eine bessere / andere Idee hat.

An einigen Stellen habe ich Word- und Visio-Dokumente verwendet, die als PDF "veröffentlicht" wurden, wobei das "neueste" PDF als maßgeblich gilt. Dies ist insofern gut, als Sie dann eine Sammlung haben, die Sie Ihrem Arbeitgeber / Nachfolger übergeben können. Wenn die PDF-Dateien korrekt datiert sind, können sie eine historische Aufzeichnung dessen enthalten, was passiert ist, obwohl eine solche Aufzeichnung nicht einfach zu durchsuchen ist. Es ist schlimm, dass ich Word oder Visio nicht mag und gezwungen bin, ein grundlegendes Verständnis dieser Tools zu erlangen, um die Ideen effektiv zu kommunizieren.

Mein jetziger Arbeitgeber spielt mit der Idee von Word-Dokumenten in einem Sharepoint-Portal. Wir müssen nur sehen, wie weit wir dort sind

Natürlich solltest du dich darum kümmern. Jeder Job, der es wert ist, getan zu werden, ist es wert, gut getan zu werden.

1.) Es wurde bereits gesagt, aber es muss zur Wiederholung wiederholt werden. Dokument, Dokument, Dokument. Verwenden Sie Excel-Tabellen, Briefpapier, Federkiel und Pergament, wenn Sie müssen. Notfalls mehrere tausend Methefte wie im Film "Se7en". Legen Sie es so oder so klar, präzise und leicht lesbar dar, für wen auch immer Sie ersetzt werden müssen, wenn Sie von einem Meteor getroffen werden.

2.) Sobald Sie alles dokumentiert haben, sollten Sie in der Schreibstimmung sein. Es ist Zeit, ein Nebenprojekt zu starten, in dem die auf den Servern vorgenommenen Änderungen der letzten Jahre aufgeführt sind. Beginnen Sie mit dem Aufbau eines Change-Management-Prozesses, aber gehen Sie ihn historisch durch. Stellen Sie sicher, dass Sie notieren, wie oft Sie diese Datenträger auf einigen dieser heiklen Server geändert haben. Wie viel sie kosten usw. Sie können sich auf diese Daten verlassen, auch wenn dieser Meteor Sie vermisst und stattdessen den Hund des Nachbarn aus dem Weg räumt.

3.) Implementieren Sie ein Überwachungssystem, das kritische Fehler überwacht und per E-Mail versendet. Was ist das, sagst du? Hast du schon einen? Süss! Jetzt dokumentiere es. Wie es funktioniert, was Sie überwachen, warum Sie es überwachen.

4.) Sie haben die Verantwortung, es wieder Ihren Managementtypen zu überlassen. Und immer wieder. So oft du kannst. Höflich sein. Seien Sie respektvoll, aber tragen Sie die Kosten für das Geschäft, wenn dieser Meteor herunterfällt und Sie verschwinden.

Dies ist keine Verantwortung, die Sie aufgeben können, sondern eine ethische Anforderung an Ihre Arbeit, die Sie als sprichwörtlicher "Bewahrer und Hüter der Schlüssel zum Königreich" bekennen.

Denk darüber so. Wenn Sie vermeiden und vergessen können, sich darüber Sorgen zu machen, und sich dabei in Ordnung fühlen, warum kämmen Sie dann nicht die Buchhaltungs-Fileshares für Unternehmensgehälter, um zu sehen, was und wie viel mehr diese Managementtypen als Sie verdienen. Warum nutzen Sie vertrauliche Unternehmensdaten nicht für Ihren eigenen Gebrauch? Warum liest du keine E-Mails?

Einfach ausgedrückt (und hoffentlich) tun Sie diese Dinge nicht, weil Sie ein solides Gespür für Moral und Ethik haben. Weißt du, das Ganze ist richtig oder falsch. Wenn Sie das haben, wissen Sie, dass es eindeutig Ihre Verantwortung ist, Gegenmaßnahmen gegen den schlimmsten Fall zu dokumentieren und vorzubereiten.

Dies ist Ihre arbeitsfreie und erholsame Urlaubsreise nach Hawaii. :)

(Also ohne Meteor.)

Überqueren Sie vorsichtig die Straße, schauen Sie in beide Richtungen und stellen Sie sicher, dass keine Busse mit Keanu Reeves und Sandra Bullock die Straße entlang fahren.

Wenn Sie die Lernkurve für Ihren Ersatz verringern möchten, können Sie am besten eine Dokumentation des Aufbaus und Ihrer Prozesse erstellen. Möglicherweise ist der einfachste Weg, dies zu tun, irgendwo ein Wiki-System einzurichten und es einfach weiter zu ergänzen. Einiges davon wird veraltet sein, aber was nicht ist, wird von unschätzbarem Wert sein.

Die vielen oben genannten Beiträge zur Wichtigkeit der Dokumentation sind genau richtig, aber es gibt noch einen weiteren Aspekt, wenn man "der Typ" bei der Arbeit ist, nach dem man Ausschau halten möchte.

Wenn Sie die einzige Person sind, die alles beherrscht, sind Urlaube / Geburten / Notfälle schwer zu bewältigen, und Sie können niemals befördert werden oder andere Positionen im Unternehmen erlernen (wenn dies Sie interessiert). Wenn Sie nicht in der Lage sind, zu wachsen, zu lernen und Ihre Fähigkeiten zu erweitern, könnten Sie in einer Position landen, in der Sie nach einem Job suchen, und Ihr Lebenslauf zeigt, dass Sie 10 Jahre als COBOL / FORTRAN-Programmierer oder Programmierer verbracht haben OS \ 2 / Novell / NT-Administrator.

Wachstum und Überanstrengung sind für die Entwicklung als Systemadministrator wichtig. Anstatt "der Typ" zu sein, von dem das gesamte Netzwerk abhängt, sei "der Typ", der immer bereit ist, dem Neuen zu zeigen, was zu tun ist und der immer daran interessiert ist, mehr über das Geschäft zu erfahren.

Der Schlüssel hier ist eine detaillierte und vollständige Dokumentation. Dies ist nicht nur für den Fall kritisch, dass Sie arbeitsunfähig sind, sondern auch, wenn eine jüngere Person hereinkommt und Sie in den Urlaub fahren möchten (oder auf grünere Weiden gehen möchten). Wenn Sie über die richtigen Dokumente und Referenzen verfügen, kann dies für andere sehr hilfreich sein, um sich über das Netzwerk zu informieren.

Ich versuche SEHR SCHWER, um sicherzustellen, dass wir keine SPoF-Kenntnisse haben, einschließlich meiner eigenen. Diese Einstellung ist wertvoller als jedes lokale Wissen, das ich für mich behalten hätte.

Ich habe diese Position (Sys Admin / Lead Dev) von einem Typen übernommen, der seine eigene Art hatte, alles zu machen. Die 17 Server, die wir haben, sind alle leicht unterschiedlich eingerichtet. Es gibt hier so viele Verfahren und manuelle Bearbeitung von Problemen, und kaum eines davon wurde dokumentiert (die Dokumentation enthielt so gut wie eine einzeilige Erklärung jedes Servers und seiner Rolle). Dies hat mich veranlasst, viele Prozesse im Büro neu zu bewerten. Jedes Mal, wenn ich etwas lerne, wird es dem Wiki hinzugefügt. Ich delegiere auch einige Serverarbeiten an andere Entwickler, damit diese zumindest minimale Informationen über kleine Jobs erhalten.

Dokumentationsschreiben ist zum Kotzen, aber überlegen Sie, wie es wäre, ohne irgendetwas in Ihre Position zu kommen.

Dokumentation ist eine große Sache. Wo ich gerade bin, habe ich genau das gegenteilige Problem wie Sie. Wir haben kürzlich ein neues POS / Order Tracking-System eingeführt (wir sind eine Gravur- und Werbeagentur) und ich habe das Problem, Leute dazu zu bringen, in das zu schreiben System die Informationen über die Anpassung. Hauptsächlich Leute auf niedriger Ebene, da der Manager dies für ihre Bestellungen tut, weil sie es für alle Bestellungen getan hat und es in eine SEHR ALTE Zugangsdatenbank gestellt hat. Ich so will papierlos gehen, und es ist durchaus möglich , in unserem Geschäft, aber ich kann einfach nicht bekommen die Menschen die Arbeit , um Informationen in, verdammt noch mal eingeben.

Also, steckt weiter bei der Autorisierung weg. Oder wenn Sie sich gut fühlen, tun Sie es in Ihrer eigenen Zeit. Es könnte eine gute Sache für Ihre Zukunft im Unternehmen sein, ganz zu schweigen von Ihrem Nachfolger.

re: soll es mich interessieren

Wenn Ihr Büro nicht zu 100% gestört ist, werden die Leute bemerken, dass Sie dafür sorgen, dass die Dinge reibungsloser funktionieren. Dass Ihnen das Wohlergehen des Unternehmens am Herzen liegt und Sie nicht nur an Ihrer „Unentbehrlichkeit“ festhalten. Das Unternehmen, das darauf setzt, dass Sie niemals ein besseres Angebot abgeben oder erhalten, funktioniert nicht sehr gut. Es ist jemandes JOB, zu bemerken, dass Sie so etwas der Firma vorenthalten.

Ich persönlich LIEBE es, mit Menschen zu arbeiten, die dokumentieren und wollen, dass die Arbeit, die sie beendet haben, für sich steht und nicht ständig ihre Beteiligung erfordert. Wenn Sie die bereits erledigten Arbeiten dokumentieren und hinter sich lassen, haben Sie mehr Zeit, um an zukünftigen Projekten zu arbeiten.

Wir haben im Grunde die gleiche Situation. Aus diesem Grund hat mich der Regisseur beauftragt, einen weiteren Wissensknoten hinzuzufügen.

Aber ehrlich gesagt, ist es nicht Ihr Platz, um sich zu sorgen. Es ist Aufgabe des Managements, Risiken einzuschätzen und anzugehen.

Ich habe festgestellt, dass der Ansatz „ Getting Things Done“ dabei hilft, die anfängliche mentale Barriere zu überwinden, die Sie daran hindert, Ihre Arbeit ordnungsgemäß zu dokumentieren. Stellen Sie sich Dokumentation nicht als monolithische Aufgabe vor, die Sie daran hindert, "echte" Arbeit zu leisten, sondern unterteilen Sie sie in mundgerechte Abschnitte. Notieren Sie sich alle Informationen, die Ihr Nachfolger wissen sollte. Dann reservieren Sie ein oder zwei Stunden pro Woche, um Ihr Wissen zu überprüfen, zu klären und zu kategorisieren.

• Dokumentation: Wichtig
• Ihre wertvolle Arbeit: Nicht so wichtig, wie Sie denken

Nicht dokumentieren. Teile dein Wissen nicht mit anderen. Indem Sie Dinge dokumentieren, verlieren Sie an Wert. Sie werden weniger bezahlt. Ihr Bonus wird geringer sein. Ihre Arbeitsplatzsicherheit wird verringert. Wieso würdest du das machen?

Das richtige Gleichgewicht ist, wenn Sie im Schlaf oder im Urlaub nicht unnötig gestört werden. Ansonsten entwerten Sie sich.