Dokumentation ist nicht jedermanns Sache und verschiedene Teile eines Projektes unter einen Hut zu bekommen ist nicht unbedingt einfach. Pragmaticworks versucht dieser Anforderung mit dem BI Documenter gerecht zu werden.

Das Problem ist vielschichtig. Es gibt z. B. keinen Standard für Dokumentationen und was alles darin enthalten sein soll. Wenn man im BI Umfeld unterwegs ist und so verschiedene Komponenten wie DB, SSAS, SSIS, SSRS einsetzt, wird schnell mal das ein oder andere vergessen, bzw. liegt gerade nicht im Fokus desjenigen, der die Dokumentation erstellen soll.
Schauen wir mal zuerst, was die Software leistet und werfen danach einen Blick auf die Punkte, die weiterhin Schwierigkeiten bereiten können.

Was kann ich mit dem BI Documenter machen?

Zentraler Angelpunkt des Tools sind Zusammenstellungen verschiedener Objekte, über die definiert wird, was alles in der Dokumentation enthalten ist. In einem weiteren Schritt kann man die Informationen über diese Objekte sammeln und als Snapshot in einem Repository ablegen. Aus diesen Snapshots wird die Dokumentation erstellt. Alternativ ist es auch möglich zwei Snapshots miteinander zu vergleichen und hier die Unterschiede zu dokumentieren. So kann man sich einen Überblick über verschiedene Versionen einer BI-Lösung verschaffen. In diesem Beispiel wollen wir mit einer Solution arbeiten, die den Namen Support erhält:

Zu einer Dokumentation können verschiedene Elemente (DB, SSAS, SSIS, SSRS) gehören. Die Software ermöglicht es dem Anwender beliebig viele Elemente einer Art hinzuzufügen.

Hierbei werden natürlich Verbindungen über Windows Authentifizierung und SQL Login unterstützt. Auch passwortgeschützte Integration Services Pakete lassen sich verwenden.

Tools

Wie bereits erwähnt lassen sich Snapshots vergleichen, aber auch die Verbindungen zwischen einzelnen Elementen grafisch auswerten. Wenn man selber etwas Hand anlegt, kann man auch ein ER-Diagramm erstellen, welches später in der Dokumentation verwendet werden kann. Dies beschränkt sich aber nicht alleine auf die Datenbank-Objekte, sondern kann auch alle anderen Elemente, wie z. B. Datenflusstask enthalten. Weitere Pfeile, Shapes und Flowcharts stehen hier zur Verfügung und runden das Bild ab.
Die teilweise zeitintensive Erstellung der Ergebnisse lässt sich bequem über den Windows Scheduler einplanen. BI Documenter liefert hier ein Tool mit, um den Aufruf über die Kommandozeile zusammen zu stellen.
Der Zugriff auf all diese Funktionalitäten ist über die Tools möglich:

Ergebnisse

Die Zwischenergebnisse werden in einer SQL Server Datenbank (Metabase) abgespeichert und stehen nicht nur für die direkten Auswertungen zur Verfügung, sondern können auch noch über verschiedene mitgelieferte Reports analysiert werden. Als Ergebnis stehen mit HTML und CHM (kompilierte HTML-Hilfedatei) außerdem auf jeden Fall die Klassiker auf dem Programm. Für deutschsprachige Anwender ist darauf zu achten, die entsprechende Option (Output mit Unicode Encoding) zu aktivieren, damit auch die Umlaute mitgeschrieben werden können.
Anbei eine Auflistung der Elemente, die in der Dokumentation für Datenbanken und SSIS-Pakete enthalten sind:

Besonders positiv fiel auf, dass auch der Workflow eines SSIS-Pakets vollständig als Grafik in die Dokumentation aufgenommen wurde, denn ein Bild sagt ja mehr als tausend Worte. Daneben werden die Variablen und Verbindungsmanager aufgeführt:

Als weiterer Bonus sind in der Doku Empfehlungen (Recommendations) enthalten, die zu den einzelnen Elementen (Datenbank, SSAS, SSIS, SSRS) eine Art "Best Practice"-Anleitung ergeben.

Online Support

Angenehm überrascht war ich von der Möglichkeit aus dem Tool heraus direkt Online Support anfordern zu können.

Nach Eingabe seiner EMail-Adresse kann man den Chat starten und auch morgens früh in unserer Zeitzone konnte ich schon einen Mitarbeiter vom Support kontaktieren. Die Firma an sich ist in Florida beheimatet und bietet bei umfangreicheren Fragen auch die Möglichkeit über eine webbasierte Meeting-Software kniffligere Fragen gemeinsam zu erarbeiten.

Product Trial

Mit der kostenlosen Demoversion kann man bereits seine ersten Erfahrungen sammeln. Der Output ist allerdings limitiert, bietet aber zumindest einen guten Überblick über das was möglich ist.

Macht das Tool alles für mich?

Eindeutig Nein! Um den Dokumentationsautomaten wirkungsvoll nutzen zu können, wären Regeln für die Ersteller/Designer von Reports hilfreich, damit dort sprechende Namen und Informationen stehen, die man für gewöhnlich suchen würde.
Wie meine ich das?
Nehmen wir einmal die Information "textbox11" aus einem Report. Das hätten die Designer bereits sprechender machen müssen, damit die Doku auch was "aussagt". Dies steht natürlich im Widerspruch zum Ansatz "schnell mal eben entwickeln, egal wie so eine Textbox heißt, sieht ja eh keiner".

Wer ein Tool zur Dokumentation seines Servers sucht, ist hier auch fehl am Platz. Jobs und Konfiguration des Servers sind leider nicht enthalten.

Fazit

Das Gesamturteil fällt sehr positiv aus, da hier unter einem Dach die verschiedenen Elemente einer BI-Lösung dokumentiert werden und auch unterschiedliche Versionen verglichen werden können.