SQL Practice Blog – SQL Server, BizTalk und .NET Erfahrungen

Dokumentation von BizTalk Solutions

leave a comment »

Ich werde immer häufiger gefragt, wie man am besten eine BizTalk Anwendung dokumentiert. Aus meinen Erfahrungen heraus reichen hierfür im wesentlichen zwei Programme von Microsoft und ein ganz klassisches Werkzeug:

  • Microsoft Word
  • Microsoft Visio
  • Flipchart oder Whiteboard

Bevor man mit der Entwicklung einer BizTalk Anwendung beginnt, sollte man sich im klaren darüber sein welche Probleme die Anwendung lösen soll und vor allem welche Systeme und Softwareprodukte in die Lösung integriert werden sollen. Hierzu empfiehlt es sich die gegebenen Anwendungen und Systemlandschadt auf einem Flipchart oder Whiteboard aufzuzeichnen. Wieso sollte dies nicht Initial in Visio geschehen? Es ist bewiesen das Menschen unkreativer und auf die technischen Möglichkeiten des Programms das sie nutzen fixiert sind, wenn sie am Computer arbeiten. Deswegen einfach das Notebook mal zu Seite stellen, sich einen Stift nehmen und seiner Kreativität und Ideen freien lauf lassen. Man wird bei Zeiten merken das gerade wenn man diese Arbeit mit mehreren Personen durchführt, sehr interessant und auch gute Lösungsansätze ent-stehen werden, welche allein am Computer so evtl. nicht möglich gewesen wären.

Dokumentation der BizTalk Architektur

Wer die Systemlandschaft bzw. die Architektur der BizTalk Anwendung danach gern in Visio darstellen möchte, dem kann ich folgende Visio Shapes empfehlen:

Alle Visio Shapes funktionieren auch mit Visio 2010.

image

Dokumentation der Geschäftsprozesse (BPM)

Die Dokumentation von Prozessen kann man besten über Microsoft Word und Visio realisiert werden. Die textuelle Beschreibung der Prozesse inkl. der Akteure geschieht am besten in Word. Die Prozesse selbst lassen sich dann super mit der Hilfe der Unified Modeling Language (UML) und einen Aktivitätsdiagramm abbilden. Das Zusammenspiel von Akteuren und verschiedenen Prozessen, lässt sich mit Hilfe eines UML Sequenz-diagramms darstellen.

Automatische Dokumentation einer BizTalk Anwendungen

Es gibt natürlich auch die Möglichkeit eine bestehende BizTalk Anwendung automatisch dokumentieren zu lassen. Die .NET Entwickler kennen ähnliche Ansetze aus der .NET Entwicklung, wo man mit Hilfe von Sandcastle automatisch eine .chm Datei erzeugen kann. Diese .chm Datei ist von der Struktur her, nach der Architektur der Anwendung erstellt und beinhaltet alle Klassen und deren Methoden inkl. der Summary –Dokumentation und Parameter der Funktionen.
Den gleichen Ansatz gibt es auch für BizTalk. Hier werden alle Artefakte und Assemblies dokumentiert, wobei hier auch die Inhalte der Beschreibungsfelder der einzelnen Artefakte mit einbezogen werden. Die Ausgabe der Dokumentation kann als Windows Help File oder HTML Website geschehen.
Des Weiteren ist es möglich neben den normalen Artefakten auch alle Messaging Komponenten und die Business Rules mit Hilfe der Tools zu dokumentieren.

image
Folgende Tools kann ich besonders empfehlen und funktionieren auch schon mit dem BizTalk Server 2010:

Ich hoffe damit einen kleinen Überblick über die Dokumentationsmöglichkeiten und –Werkzeuge des BizTalk Servers gegeben zu haben.

Written by Robert Meyer

Juni 3, 2010 um 10:28

Veröffentlicht in BizTalk

Tagged with , , , , ,

Schreibe einen Kommentar

Trage deine Daten unten ein oder klicke ein Icon um dich einzuloggen:

WordPress.com-Logo

Du kommentierst mit Deinem WordPress.com-Konto. Abmelden / Ändern )

Twitter-Bild

Du kommentierst mit Deinem Twitter-Konto. Abmelden / Ändern )

Facebook-Foto

Du kommentierst mit Deinem Facebook-Konto. Abmelden / Ändern )

Google+ Foto

Du kommentierst mit Deinem Google+-Konto. Abmelden / Ändern )

Verbinde mit %s

%d Bloggern gefällt das: