Word Wiki

Ich habe an mehreren Stellen über "Dokumentationen" geschrieben und wie schwer sich Administratoren damit tun, wo es denn so einfach ist. Und erstaunlicherweise ist die Struktur und das Layout für viele ein Hindernis. Sie haben Angst, dass das Ergebnis nicht "professionell" aussieht oder unstrukturiert wirkt. Nicht jeder sieht vor seinem inneren Auge schon die Gliederung des fertigen Dokuments oder hat eine Vision. Doch schon Helmut Schmidt (?) sagt mal, dass jemand mit Visionen besser zum Arzt geht.

Glauben Sie mir: Auch die Struktur der MSXFAQ ist nicht statisch sondern passt sich quasi mit jeder neuen Seite wieder an und genau die vielen kleinen Seiten machen es mit einfach, einzelne Inhalte zu ergänzen, zu erweitern oder auf Seiten zu verteilen und zusammen zu fassen. Und genau so kann auch eine Dokumentation aussehen.

Überlegungen zur Technik

Mit welcher Technik Sie dies machen, bleibt ihnen überlassen. Es könnte ja z.B. ein Wiki sein, oder ein großes Word-Dokument. Ich habe zu Exchange 2003 ein Buch geschrieben und da noch mal richtig können gelernt, was Word alles kann. Eine passende DOT-Vorlage verhindert "wilde Formatierungen" und ein Satz von Makros baut am Ende aus den einzelnen DOC-Dateien pro Kapitel das komplette Buch "druckfähig" mit Inhaltsverzeichnis, Stichwortverzeichnis, Seitenzahlen etc. zusammen. Da steckt ganz viel Arbeit drin, die aber für das "Ausgabemedium Papier" natürlich auch gerechtfertigt ist.

Für eine interne Dokumentation, an der auch mehrere Personen arbeiten sollen und die komplett unterschiedliche Zielgruppen hat, gelten etwas andere Anforderungen. Und eigentlich haben Sie schon alles in ihrer Firma aber nutzen es vielleicht einfach noch nicht "richtig".

  • Erstellen
    Das primäre "Dokumentationswerkzeug" von Admin ist eigentlich eine leistungsfähige Textverarbeitung. Dass Millionen von Anwendern über Browser auf Wikipedia, Wordpress etc. Artikel erstellen, ist nicht falsch aber diese Personen wollen selbst aktiv sein und erlernen gerne die Syntax eines Wiki-Artikels und auch ein Bild speichern, hochladen und dann verknüpfen nehmen Sie gerne auf sich. In Firmen ist Dokumentation oft ein notwendiges Übel, welches einfach sein muss. Und Texte und Bilder in Word-Dokumenten über die Zwischenablage zu importieren ist nun mal sehr einfach. Und wenn die einzelnen Artikel "überschaubar" sind, dann ist der Einstieg auf einfacher.
  • Ablage mit Versionierung und Berechtigung
    Die erstellten Dokumente müssen gespeichert werden. Hier bietet sich SharePoint ja geradezu an. Dies ist eine Ablage, die sowohl per Browser als auch als Dateishare angesprochen werden kann, eine integrierte Authentifizierung erlaubt und sogar eine Versionierung unterstützt. Und man kann zuständige Personen hinterlegen, die der Owner eines Dokuments sind oder ein leeres vorbereitetes Dokument zu füllen haben.
  • Anzeige
    Das primäre Betrachtungswerkzeug ist vielfach der Browser. Also sollten die Anzeige der Daten als HTML-Datei erfolgen. Wenn es sogar statische Seiten sind, dann können diese einfach kopiert oder offline mitgenommen werden, was ein Desaster Handbuch ebenfalls gut unterstützt.
  • Inhaltsverzeichnisse
    Es gibt in einer Firmendokumentation nicht mehr das eine große Inhaltsverzeichnis, in dem sich keiner wieder findet. Nützlicher sind "Themenseiten", die Inhalte durch eine sinnvolle Verlinkung auf andere ausgewählte Seite zusammenführen. Natürlich muss dazu jede Dokumentseite in sich autark und abgeschlossen sein.

Viele werden nun sagen, dass das ganze doch nicht neu und als Wiki schon lange gelebt wird. Und ich gebe ihnen vollkommen recht dazu, nur dass die klassischen Wikis für die meisten Administratoren nur bedingt funktionieren. Das Erstellen von Inhalte ist einfach zu schwer. Ein Word Dokument auf Basis einer Vorlage kann aber jeder Erstellen und selbst Bilder lassen sich einfach per Zwischenablage einfügen und zuschneiden. Warum also nicht all diese vorhandenen Hilfsmittel geschickt kombinieren ?.

Der Prozess

Ich habe verschiedene Überlegungen angestellt aber würde nun folgendes Modell umsetzen:

  • DOCX-Speicherplatz
    Zuerst wird ein Platz für die Ablage von einer Word Formatvorlage (DOTX) und zur Ablage der Dokumentationen als DOCX-Dateien gesucht. Das kann ein einfacher Dateiserver sein, es kann aber auch eine SharePoint Dokumentlibrary sein. SharePoint hätte den Vorteil, dass der Zugriff per HTTP von überall einfacher ist, dass die DOTX-Vorlage vorgegeben werden kann und SharePoint auch die Versionierung und Benachrichtigung bei Änderungen übernehmen kann.
    Der Administrator startet z.B. ein leeres Dokument und schreibt dort einfach nur seine Informationen hinein mit Überschriften, Aufzählungen und Bildern. Danach speichert er das Dokument mit einem eindeutigen Namen ab.
  • Konverter
    Dann gib es einen Konverter, der die Word-Dokumente nimmt und in HTML-Dateien überführt. Dabei nutzt er eine HTML-Vorlage, die das Layout vorgibt und zudem können Links zum originalen DOCX-File für eine spätere Bearbeitung hinterlegt und weitere Metadaten eingebunden werden. Zudem muss der Konverter natürlich Hyperlinks ergänzen.
  • HTML-Speicherplatz
    Die Ergebnisse landen in einem Verzeichnis, welches über einen Webserver erreichbar ist. Dies sind komplett statische HTML-Seiten und können so auch offline (z.B. Desasterhandbuch) mitgenommen werden.
  • Andere Anwender können per Browser diese HTML-Dateien lesen und den Links folgen. Sie können sogar über den Link zur DOCX-Datei direkt die Quelle bearbeiten.

Hier ein Bild des Ablaufs.

Zu klären ist nun nur noch das Skript (Nr.3), welches die Arbeit verrichtet. Es kann als geplanter Task einfach gestartet werden, was natürlich eine Verzögerung zwischen Abspeichern der Word-Datei und der Verfügbarkeit der HTML-Datei bedeutet. Mit SharePoint könnte diese Prozess auf dem Server nach dem upload getriggert werden.

Durch diese Trennung von Source und Web-Version können Änderungen immer am DOCX-File durchgeführt werden und Word wird nicht genutzt, um (schmutziges) HTML zu erzeugen. Der Administrator kann mit Word als Editor arbeiten, der z.B. eine besonders einfache Einbindung von Bildern erlaubt und dennoch vergleichbar zu einem WIKI arbeiten. Die "Contentebene" ist bis auf die Formatvorlagen nicht weiter formatiert.

Word Datei

Es ist natürlich genauso denkbar, OpenDocument-Text-Dateien (ODT) zu verwenden, die Word aber auch LibreOffice und andere Programme verarbeiten können.
http://de.wikipedia.org/wiki/OpenDocument
Schwerpunkt ist aber nicht das Dateiformat, sondern die EditorMöglichkeiten.

Ich nutze schon lange sowohl Outlook als auch Word um schnell zu dokumentieren. Ich verzichte dabei Anfangs komplett auf Kopfzeile, Fußzeilen, Inhaltsverzeichnis, Deckblatt und andere Nebensächlichkeiten, sondern beschränke mich auf den Inhalt und formatiere mit Titel, Überschriften, Aufzählungen etc. Das kann dann wie folgt aussehen

Übrigens können Sie genauso schnell eine Mail in Outlook erfassen. Vielleicht gibt es ja bald eine Möglichkeit per Mail eine Dokumentation zu erweitern. Word lässt sich mit "Dokumentvorlagen" sehr gut steuern. Damit eine Dokumentation "aus einem Guss" aussieht, sollte die Vorlage aber gewisse Formate vorgeben und die Autoren auch bitte nicht davon abweichen.

Layout und Formatierung

Zielausgabe soll ja HTML sein. Dazu wird eine HTML-Vorlage erstellt, die mit klassischen Elementen wie CSS und Bildern den Rahmen für die Dokumentation liefert und den Text auch formatiert. Hier mal ein Entwurf, von dem natürlich abgewichen werden kann.

Analog zu den Formatvorlagen in Word sollte es passende CSS-StyleSheets geben, so dass hier eine 1:1 Übereinstimmung möglich ist, wie z.B.

  • Überschriften H1-H4
  • Aufzählungen und Nummerierungen
  • Tabellenvorlage
  • Textblöcke zur Hervorhebung wie Warnung, Information, Fehler, Wichtig, Code
  • Format für Hyperlinks zu anderen Seiten

Natürlich wird das generelle Layout vorgeben und soll vor allem eine einfache Konvertierbarkeit von DOCX nach HTML erlauben. Schließlich soll die Ausgabe als HTML-Datei einfach mit jedem Browser zugänglich oder idealerweise auch offline verfügbar sein.

Details zur Generierung

Wo die DOCX-Dateien letztlich liegen ist egal, solange der Konvertierungsprozess einfach darauf zugreifen kann und z.B.: per Zeitplaner nach Änderungen suchen kann. ähnlich einem Wiki ist der Dateiname auch zugleich der Titel und Hyperlink-Text. Inhaltsverzeichnisse, Sitemaps etc. sind manuell zu erzeugen. Das ist aber sogar gut, weil auch diese in Form von Dokumenten mit Links auf den Dokumentname gepflegt und damit sogar mehrere zielgruppenorientierte Inhaltsverzeichnisse existieren können.

  • Liste der Dateinamen zusammensammeln
  • Alle Dateien durchlaufen und nach Links suchen, die automatisch oder manuell erstellt werden können.
  • Bestehende Seiten überarbeiten
    • bereits angelegte Links für Seiten, die es noch nicht gibt, als leere "Baustellen-Seiten" anlegen.
    • Bestehende Seiten mit übereinstimmenden Tags als Links addieren.
    • Backlink-Seiten addieren
  • Indexseiten erstellen, z.B. für Baustellen und für einzelne Tags
  • HTML/PDF-Datei erstellen mit EDIT-Link auf die DOC-Datei für einen schnellen Zugriff

Damit ist dieser Prozess gar nicht mal so unterschiedlich von der Generierung der MSXFAQ. Ich erhoffe mir aber, dass durch die Erstellung und Pflege der Dokumente mit Word die meisten Administratoren ihre Hemmungen bezüglich "Dokumentation" etwas ablegen.

Code

 

 

Submit per Mail

In Outlook können heute auch schon sehr einfach HTML-Mails erstellt werden. Auch hier gibt es mit H1-H3 die einfache Möglichkeit Texte mit Überschriften zu versehen und Bilder einzufügen. Ich denke daran wie interessant es wäre, wenn ein Admin eine Doku einfach als Mail an wordwiki@firma.tld senden könnte und der Betreff den Seitenname und Titel vorgibt und der Body dann als Artikel erscheint. Gerade in Outlook, was im Hintergrund wohl Word nutzt, kann vergleichbar einfach in einer Mail als Dokumentation dienen:

Natürlich kann man so keine Versionierung und Bearbeitung von bestehenden Dokumenten erreichen. Aber wenn das Skript "schlau" genug ist den betreff als Titel zu nutzen und in anderen Seiten zu addieren, ist schon die Verlinkung gegeben.

Option als MSXFAQ-System

Wer die Seiten auf Backstage und insbesondere SharePoint Designer gelesen hat, wird um mein Dilemma wissen: Ich pflege (Stand 2013) die MSXFAQ immer noch mit dem SharePoint Designer 2007 und der Weg zu einer neueren Version ist mir aktuell verbaut. Ich pflege den Content als "Disk-Web" und SharePoint Designer 2010 und neuer unterstützen nur noch SharePoint Server. Ich kann sicher noch einige Jahre mit SharePoint Designer weiter arbeiten aber auf Dauer werde ich mir ein Migrationsszenario ausdenken müssen. Ich tue mich schwer mit dem Einsatz von gehostet CMS-Systemen (Jooma, Wordpress etc.), da dort die Daten in proprietären Formaten in SQL-Tabellen hinterlegt werden und aktiver Code (PHP) den Inhalt relativ "teuer" generiert. All die Dynamic der Medienwebseiten braucht ich eigentlich nicht. Ich möchte gerne weiter offline meinen Inhalt verwalten und vielleicht ist dieses Dokumentationssystem die erste Basis. DOCX oder HTML-Dateien als Grundlage mit Generierungsprogrammen zum Veröffentlichen.

Anderer Editor (Online oder ClickOnce)

Eine andere Idee wäre, wenn die Daten einem WIKI ähnlich per Browser bereit gestellt werden aber zur Verarbeitung z.B.: eine Windows Anwendung per "ClockOnce" von der Webseite gestartet wird, die dann die Seite ausliest und umfangreiche Bearbeitungsfunktionen erlauben.

Vielleicht gibt es aber auch zukünftig in modernen Browsern die Möglichkeit, Bilder über die Zwischenablage in ein Dokument einzufügen.

Weitere Links