Dokumentation in der Administration

Die Dokumentation wird in der allgemeinen Administration häufig sträflich vernachlässigt. Das ist ein Problem, weil sie ein wichtiges Werkzeug zur Ergebnissicherung darstellt. Ein Administrator, der ein System ohne Dokumentation betreibt, befindet sich in seinem System täglich im Blindflug und muss die Hölle der Fehleranalyse immer wieder aufs Neue durchleben. Auch für die Arbeit in Arbeitsgruppen ist die Dokumentation von Arbeiten und Arbeitsschritten wichtig. Hier arbeiten häufig verschiedene Administratoren zusammen, von den sich meistens jeder auf ein Spezialgebiet konzentriert. Sie treffen sich häufig an den Schnittkanten ihrer Arbeitsbereiche und ihres Fachwissens. Trotzdem ist es notwendig, das sich jeder auch einen Überblick über die Funktionsweise der benachbarten Systeme verschaffen kann, da diese in die Funktionsweise der eigenen Systeme eingreifen oder gegenseitige Abhängigkeiten bestehen könnten.

Interne Dokumentation

Die interne Dokumentation, die sich an den internen Kreis der im Administrationsbereich beschäftigten Administratoren richten, genügt meistens einer allgemeinen Form. Sie ist nicht für die Weitergabe an andere Bereiche eines Unternehmens oder an externe Stellen bestimmt und muss lediglich den Richtlinien und der Strukturierung der eigenen Abteilung entsprechen. In der einfachsten Form reicht hier für die Dokumentation eine handschriftliche Notiz in einem strukturierten Ordner aus.

Eine weite Form der internen Dokumentation richtet sich an die Anwender und Benutzer der administrierten IT-Systeme. Hierbei kann es sich um Notizen, Handreichungen oder Anleitungen handeln. Diese müssen der allgemeinen Form für interne Firmendokumente entsprechen und sollten entsprechend gepflegt und strukturiert werden.

Externe Dokumentation

Externe Dokumentation kann als Kunden-, System-, Anwendung- oder Installationsdokumentation das Haus verlassen und werden an Kunden oder externe Stellen ausgeliefert. Ihnen können durch Unternehmen spezielle Bedingungen hinsichtlich Form und Struktur vorgegeben sein. Die Herausgabe von externer Dokumentation sollte nur in Absprache mit Vorgesetzten erfolgen, eventuell sind spezielle Freigaben aus der Normung und oder anderen Abteilungen notwendig.

Dokumentationsarten

Projekt und Systemdokumentation

Projektdokumentationen bestehen meistens aus mehreren Abschnitten, die die Durchführung und Planung eines Projektes aus kaufmännischer, technischer, administrativer und Anwendersicht beschreiben. Zu ihr gehören die Analyse und Planung sowie die Lasten- und Pflichtenspezifikation, ebenso wie auch Installations-, Administrations- und Anwenderdokumentation.

Installationsdokumentation

Mithilfe der Installations- oder Konfigurationsdokumentation werden die Installation und Einrichtung von Programmen und Komponenten dokumentiert. Hierbei ist auf folgende Punkte zu achten:

  • Um welches Programm handelt es sich, was sind seine Aufgaben und wo liegt der Einsatzbereich.
  • Lizenzierung, wie viele und welche Lizenzen sind vorhanden. Wie viele Lizenzen sind in Verwendung und wo wurde die Software installiert.
  • Welche Voraussetzungen müssen erfüllt sein, welche Voraussetzungen mussten erst geschaffen werden.
  • Welche Abhängigkeiten bestehen zu anderen Programmen oder Systemen.
  • Planung und Durchführung der Installation oder Konfiguration.

Anwenderdokumentation

Dieses sind Anleitungen, die Anwendern zur Selbsthilfe überlassen werden. Hierbei kann es sich um Handreichungen mit Handlungsschritten oder um Konfigurationsbeschreibungen handeln. Anwenderdokumentationen sollten in einer allgemeinen Sprache geschrieben werden, Fachbegriffe, Abkürzungen und administrationstypische Begriffe sind zu vermeiden.

Formate, Dateinamen, Revisionen und Abbildungen

Dokumentationen in der Administration entstehen sukzessive und unterliegen zukünftigen Anpassungen und Änderungen. Aus diesem Grunde sollten die Dokumente mit einer Revisionsbezeichnung versehen werden, damit das derzeitig aktuelle Dokument identifiziert werden kann. Auch sollten alle Versionen eines Dokumentes aufbewahrt werden, da an ihnen die Konfigurations- und Installationshistorie ablesbar ist. Sollte es hierfür keine betrieblichen Vorgaben geben, bietet es sich an, das aktuelle Bearbeitungsdatum in den Dateinamen mit aufzunehmen.

Hierbei hat es sich bewährt, das Datum in DIN-Schreibweise nach Jahr, Monat und Tag anzugeben, da dann eine cronologische Sortierung der vorhandenen Dokumente erfolgt. In den Dokumenten sollte diese Versionsbezeichnung ebenfalls vorhanden sein. Zusätzlich ist hier auch eine Angabe des Ablageortes des Dokuments und des Bearbeiters sinnvoll. Zur Übersichtlichkeit ist eine thematische Organisation der Dokumente in Unterverzeichnisse angebracht.

Gibt es viele unterschiedliche Dokumente in unterschiedlichen Versionen, kann es angebracht sein, eine zusätzliche Verzeichnisstruktur mit den jeweils aktuellen Dokumenten zu pflegen. Abbildungen sollten auf die gleiche Weise in einem Unterordner gesichert werden. Das Speicherformat und die Wortwahl hängen stark von der Art der Dokumentation ab. Dokumente, die sich an die Administratoren und Techniker richten, sollten in einem Format abgelegt werden, das sich einfach bearbeiten lässt. In der Wortwahl können Abkürzungen und Fachbegriffe verwendet werden, da Kenntnisse der Materie vorauszusetzen sind. Bei der Anwenderdokumentation sieht es schon anders aus. Fachbegriffe und Abkürzungen sollten auf ein Mindestmaß reduziert und Vorkenntnisse sollten zur Umsetzung der Dokumentation nicht benötigt werden. Dokumente sollten am besten in einem allgemeinen und unabhängigen oder verfügbaren Format wie PDF oder DOC versandt oder in einem allg. Dokumentationsverzeichnis abgelegt werden.

Abbildungen sind bei der Dokumentation immer ein gutes Mittel um Arbeitsschritte schnell festzuhalten. Allerdings sollten Dokumentationen nicht als reine Bilderbücher angelegt werden. Bei einigen Arten der Dokumentation sollte der Textteil den Bildteil deutlich überwiegen. Bei Abbildungen sind Kennwörter und persönliche Angaben zu schwärzen, eventuell sind auch weitere Aspekte des Datenschutzes zu beachten.

Werkzeuge für die einfache Dokumentation

Bei der Administration stehen meistens nicht alle Dokumentationswerkzeuge wie Word, Photoshop, Viso oder Mindmapper zur Verfügung. Aus diesen Gründen müssen die Werkzeuge eingesetzt werden, die vom Betriebssystem standardgemäß zur Verfügung gestellt werden. Die Nachinstallation von Officesuiten oder Grafikprogrammen auf Servern oder administrierten Arbeitsstationen zum Erstellen von Dokumentationsteilen ist zu vermeiden.

Wordpad

Das Wordpad ist ein einfaches Textverarbeitungsprogramm, das mit den einfachsten Funktionen zum Erstellen von Texten aufwartet. Es ist in allen Windows-Betriebssystemen enthalten und bietet sich damit zum Erstellen einfacher Dokumentationsdokumente an. Als Speicherformat kommt das Rich-Text-Format (RTF) zum Einsatz, das von allen gängigen Officeprogrammen gelesen werden kann. Es bietet die Möglichkeit zur einfachen Textformatierung und kann Abbildungen aufnehmen.

Notepad

Das Notepad ist ein einfacher Texteditor zum Bearbeiten einfacher Textdateien. Es eignet sich zum Bearbeiten von Skripten und zur Erstellung kleiner Dokumentationen und Notizen ohne Abbildungen.

OpenOffice portable

OpenOffice steht auf Windows nicht per Standard zur Verfügung, die Nachinstallation auf Servern und administrierten Arbeitstationen sollte vermieden werden. Für den mobilen Einsatz gibt es eine portable Version1, die von einem USB-Stick gestartet werden kann. Die Verwendung von USB-Sticks und externen Programmen kann allerdings in Unternehmen und auf Servern gegen Sicherheitsrichtlinien verstoßen, was gegen den Einsatz auf Servern spricht. Damit bleibt häufig der Einsatz des Programms auf dem Arbeitsplatz des Administrators zur Nach- und Aufarbeitung der Dokumente übrig. OpenOffice hat verschiedene Vorteile. Es stellt eine komplette Officesuite dar und bringt damit erweiterte Möglichkeiten für die Formatierung und die Aufarbeitung der Dokumente mit. Es besitzt ein Zeichenprogramm, das für einfache Diagramme und Skizzen ausreichend ist, und es kann die Dokumente in ein allgemeingültiges PDF-Format konvertieren. Damit eignet es sich besonders gut für die Erstellung von Anwenderdokumentationen, die eventuell dem speziellen Aufbau und Format zur Corporated Identity entsprechen müssen.

Bildschirmfotos

Ein Bild sagt mehr als tausend Worte und kann insbesondere für die Dokumentation von Einstellungen und Vorgaben sinnvoll sein. Unter Windows kann mit der Tastenkombination <DRUCK> ein Abbild des aktuellen Bildschirms in die Zwischenablage kopiert werden. Mit der Tastenkombination <ALT>+<DRUCK> wird ein Abbild des aktuell aktiven Fensters in der Zwischenablage abgelegt. Aus der Zwischenablage kann die Abbildung in andere Programme eingefügt werden. Sollen die Bilder in einem Dokumentationsverzeichnis zwischengespeichert werden, sind diese in einem Bildbearbeitungsprogramm zu importieren und danach im entsprechenden Verzeichnis abzulegen.

MSPaint

MSPaint ist ein einfaches Bildbearbeitungsprogramm, mit dem sich Bildschirmfotos um Informationen erweitern oder Ausschnitte extrahieren lassen. Es bietet einfache geometrische Formen und Textelemente für die Bearbeitung an und kann Bilder für die weitere Dokumentation in Verzeichnissen speichern. Bei der Einrichtung des Programms sollten die Bildattribute angepasst werden, damit neue Bilder immer mit 1×1 Pixel erstellt werden. Damit können Bilder aus der Zwischenablage direkt eingefügt werden und es verbleiben keine weißen Ränder einer darunter liegenden weißen Seite. Soll eine neue Grafik bearbeitet werden, kann diese mit der Tastenkombination <STRG>+<N> direkt erstellt werden. Als Speicherformat für die Abbildungen bietet dich des Format PNG oder JPG an.

Freemind

Freemind2 ist ein freies Programm zum Erstellen von Mindmaps. Hiermit können Planung und Ausführung von Arbeiten strukturiert geplant und dokumentiert werden. Es eignet sich auch sehr gut zum Aufzeichnen von Wissen und der Dokumentation von Programm- und Bedienstrukturen. Das Programm benötigt das Java Runtime Environment von Orakel und eignet sich damit auch nur für die Installation auf dem Arbeitsplatzrechner des Administrators.

Structorizer

Der Structorizer3 ist ein freies Programm, das sich ebenfalls nur für den Arbeitsplatz des Administrators eignet. Mit ihm lassen sich Skripte und Programme als Nassi-Shneiderman-Diagramm planen. Die erstellten Diagramme eignen sich sehr gut für eine spätere Dokumentation umgesetzter Lösungen, und der Gesamtüberblick vereinfacht die Analyse und die Fehlersuche.

Foxit PDF Reader

Foxit PDF Reader4 ist ein frei verfügbarer PDF-Reader, der in der Lage ist, PDF-Dokumente mit Kommentaren und Markierungen zu versehen. Das Programm eignet sich damit gut zum Kommentieren von Dokumenten und ist als Portable-Version5 verfügbar.

Vorgaben für Einreichungen

Auf folgende Vorgaben wird von mir bei zur Benotung eingereichter Dokumente Wert gelegt:

Allgemeine Vorgaben

Diese Vorgaben sind in allen eingereichten Dokumenten zu erfüllen.

  • Auf jeder Seite den Namen und den Klassenraum / Hörsaal.
  • Auf jeder Seite das Datum, Seitennummer und Seitenanzahl.
  • Eine stringente Form des Dokumentes in Schrift, Satz, Format und Abbildungen.
  • Strukturierung des Dokumentes und des Inhaltes, Verwendung von Überschriften.
  • Ausreichender Heftrand auf der linken Seite.
  • Kurzer einleitender Text am Anfang des Dokumentes.
  • Beschriftung von Abbildungen und Tabellen.
  • Verwendung von Fußnoten und Quellnachweise.

Vorgaben für Installationsanleitungen oder Arbeitsproben

Dokumentationen, die nur zur Ergebnissicherung für den Teilnehmer dienen und nicht eingereicht werden, bedürfen keiner speziellen Form. Vor einer Einreichung sind die Dokumente zu überarbeiten und in Form zu bringen. Bei Arbeitsproben sind folgende Vorgaben zusätzlich zu erfüllen:

  • Die drei Phasen der Planung, Umsetzung und Prüfung müssen in dem Dokument enthalten und umgesetzt sein.
  • Tabellarische Aufstellung der verwendeten Arbeitszeit, mit Datum, Zeit und Arbeitsbeschreibung.
  • Am Ende eine kurze Zusammenfassung und Beleuchtung aufgetretenen „Herausforderungen“.

Vorgaben für Hausarbeiten

Hausarbeiten dienen der Reflexion und Auseinandersetzung mit einem thematischen Bereich. Bei der Dokumentation sind folgende zusätzliche Vorgaben zu beachten.

  • Verwendung eines Deckblattes mit Titel, Name, Anriss, Datum, Klassenraum / Hörsaal. Die Rückseite des Deckblattes ist nicht zu verwenden. Das Deckblatt bekommt keine Seitennummerierung. Die Nummerierung der Seiten fängt mit der ersten Seite des Textteils an.
  • Die thematische Auseinandersetzung muss erkennbar sein.
  • Die Ausarbeitung hat in ganzen Sätzen zu erfolgen. Auf Textfluss, Absätze und Lesbarkeit ist besonders zu achten.
  • Das Dokument ist in einen Hauptteil und einen Nebenteil als Anhang zu gliedern. Nebenläufige Information, die zwar sinnvoll aber für den Hauptteil nicht notwendig sind, sind in den Anhang zu verschieben. Das betrifft insbesondere Tabellenwerke und Normungsauszüge. Die Seiten des Anhangs sind mit römischen Zahlen zu nummerieren, die Nummerierung des Anhangs beginnt wieder mit der Nummer 1.
  • Der Anhang muss Verzeichnisse für Inhalt, Tabellen und Abbildungen enthalten.

Form der Einreichung

Alle Dokumente sind ausgedruckt und vom Teilnehmer unterschrieben in Papierform einzureichen. Eine zusätzliche Einreichung als PDF-Dokument ist möglich. Die Einreichung von Präsentationen hat als ausgedrucktes Handout der Präsentation zu erfolgen. Dieses ist mit den Funktionen der Präsentationssoftware zu erstellen, es sind mehrere Folien auf einer Seite unterzubringen.

Interne Ressourcen

DateinameDateigrößeLetzte Änderung
2011-08-20_Dokumentation_in_der_Administration.pdf378.3 KiB2011-08-20 15:23

Externe Ressourcen

wiki/seminare/handreichungen/dokumentation_in_der_administration.txt · Zuletzt geändert: 2011-08-23 21:34 von Marek Walther