Architekturdokumentation einer SOA

[Laddi1987]

Hallo zusammen!

Ich entwickle im Rahmen meiner Abschlussarbeit eine Systemarchitektur im TV Broadcast Kontext. Ich habe mich bereits dazu entschlossen die fachlichen Anforderungen durch eine SOA umzusetzen, Servicekandidaten und Prozessmodelle sind schon gestaltet und mit dem Betreuer meiner Arbeit besprochen. Nun mache ich mich an die Implementierung der einzelnen Services und möchte parallel dazu eine Dokumentation dieser für den Anhang schreiben. Die Dokumentation sollte vor allen Dingen die Prozessemodelle beschreiben sowie die entsprechenden Serviceinterfaces und Datenstrukturen und wird im Anhang meiner Arbeit Platz finden. Ich habe mir bereits die Templates des arc42 Projektes angeschaut und in das Buch "Softwarearchitekturen dokumentieren und kommunizieren" geschaut, jedoch erscheinen mir die Ansätze dort ein wenig überdimensioniert im Rahmen der Arbeit, immerhin ist es "nur" der Anhang und ich hab auch so noch genug zu tun ;-)

Nun zu meinem Anliegen: Ich bin auf der Suche nach ein wenig kreativem Input , ggf. Dokumentenvorlagen, wie ein gesunder Mittelweg zwischen Detailgrad und Aufwand im Rahmen einer solchen Arbeit aussehen könnte, da ich leider momentan ein wenig ideenlos bin wie ich da heran gehen sollte.
Ich habe schon in Erwägung gezogen, mich an der Struktur von Pflichtenheften zu orientieren, nur bin ich mir nicht sicher wie ich im besonderen Kontext der verteilten Architektur den Übergang zwischen Gesamtsicht und den einzelnen Services herstellen kann. Vielleicht stand ja jemand hier schon einmal vor einem ähnlichen Problem?!
Ich bin für jede Form der Anregung dankbar! :-)

Viele Grüße und Dank im voraus,
Laddi

 

[SmaLitro]

Bei SOAs solltest du die einzelnen Services als getrennte Projekte beschreiben. also für jeden Service eine Eigene kleine Dokumentiation und ganz wichtig mit Schnitstellen und Komunikationsprotokollen.
Wie das jeweils einzeln geht musst du ja im Studium gelernt haben.

Ansonsten "viel Glück" mit der SOA Architektur die ist IMHO sehr Dokumentationsaufwändig - plane schon mal mindestens 1/3 der ASRbeitszeit für Dokumentation ein.

 

[NuminousDestiny]

Ich werfe mal Architecture Knowledge Management (AKM) für SOA in dem Raum. Hier gibt es verschiedene Ansätze, was alles in die Dokumentation gibt. Da es sich hierbei um ein Forschungsfeld handelt muss man natürlich prüfen, ob es sich um zumindest validierte Ansätze handelt.

Diese Ansätze beschreiben ggf. was du alles in deine Doku packen solltest (Auch Entscheidungen und die "Rationale" (das Warum)).

Falls das zu viel ist, würde es auch eine 0815 Beschreibung der Topologie und der Services tun. Dafür müsste es aber auch kleine Templates geben.

 

[Laddi1987]

Hey hey,

Erstmal danke für die Anregung, ich werde in das AKM mal reinschauen. Ich habe mich inzwischen dazu entschlossen die Geschäftsprozesse zunächst in Kontexte zu unterteilen (hab ich im Rahmen der SOA Analyse eh schon gemacht als ich die Service Kandidaten abgeleitete habe). Innerhalb dieser Kontexte tauchen dann die Services in Form von zugeordneten Zuständigkeiten auf. Dann werde ich in einem zweiten Schritt, wenn die Aufgabe der Services im Gesamtkonzept klar geworden ist, in Form von Klassendiagrammen die Schnittstellen beschreiben (denn dort liegt der Fokus, die Logik dahinter werde ich in weiten Teilen garnicht implementieren müssen, für die von mir entworfene Demonstrationsumgebung reicht in den meisten Fällen eine Art Blackbox Logic, die nur für fest definierte Szenarien funktioniert).
Mal schauen wie weit ich damit komme und auf was für Ideen mich das AKM dann noch bringt.

Also erstmal vielen Dank bis hierhin und wenn noch jemand eine Idee hat: You're welcome

Grüße,
Laddi