embarc logo
embarc logo

Bestehendes nachdokumentieren

Halten Sie Ihre Architekturansätze und Ideen wirkungsvoll fest, anstatt sie zu vergessen! Fördern Sie die Kommunikation innerhalb der Entwicklung und binden Sie Kunden, Fremdprojekte und neue Teammitglieder einfacher ein.

 
 

Was erwartet Sie?

In der Theorie entsteht Architekturdokumentation bereits während des Entwurfes. Die Projektrealität sieht oft anders aus. Ihre auch? Wir unterstützen Sie dabei, im nachhinein eine passende Architekturdokumentation anzufertigen. Dazu ermitteln wir zunächst gemeinsam mit Ihnen die Zielgruppen und deren Informationsbedürfnisse, identifizieren die passenden Zutaten und Werkzeuge, und dokumentieren zusammen Ihre Lösung. Ganz pragmatisch und effizient.

In einer ersten Iteration entsteht dabei ein prägnanter Architekturüberblick, der die wesentlichen Lösungsansätze nachvollziehbar festhält.

Ihr Nutzen

Gemeinsames Lösungsverständnis

Verknüpfen Sie die zentralen Lösungsansätze mit einenden Architekturzielen und kommen Sie zu besseren Antworten als “Historisch gewachsen”.

Effizientere Einarbeitung

Bringen Sie Neue im Team durch gebrauchstaugliche Dokumentation schneller ins Tun.

Zielgruppengerecht

Lösen Sie das Versprechen ein, dass Dokumentation tatsächlich die Kommunikation unterstützt. Erarbeiten Sie lebendige Ergebnisse, die nicht im Wiki verrotten.

Rahmen für Miroservices

Beschreiben Sie die Makroarchitektur Ihrer Lösung auf nachvollziehbare Art, und geben Sie den Teams, die einzelne Services eigenständig entwickeln, das nötige Mindestmaß an Spielregeln.

Basis für Reflexion

Erarbeiten Sie eine belastbare Grundlage, um Architekturen fundiert zu bewerten.

Wiederverwendung und Konzeptionelle Integrität

Lösen Sie gleiche Probleme auf die gleiche Art und Weise. Vereinfachen Sie dadurch Ihre Lösung. Teilen Sie in einem Vorhaben erprobte Lösungsansätze über Projektgrenzen hinweg.

Ablauf

Schritt 1: Zielgruppen und Ziele identifizieren

Wir identifizieren die Zielgruppen Ihrer Architekturdokumentation und machen deren Intention explizit. An wen müssen Sie und Ihr Team ihre Ideen, Entscheidungen und Ergebnisse kommunizieren, und warum?

Schritt 2: Zutaten auswählen und initial anfertigen

Wir entscheiden, welche Dokumentationsmittel (“Zutaten”) für welche Zielgruppe in welcher Tiefe zu erstellen sind. Erste Fassungen erarbeitet Ihr Team Hand in Hand mit unseren Experten. In diesem Zusammenhang wählen wir angemessene Tools aus.

Schritt 3: Zutaten in Form bringen

Die Dokumentationsmittel legen wir geeignet ab. Wir rekombinieren sie zielgruppengerecht zu prägnanten Dokumenten, Foliensätzen, Flyern usw.

Schritt 4: Rückmeldungen der Zielgruppen einholen

Eine erste Überprüfung auf Gebrauchstauglichkeit erfolgt gemeinsam mit Vertretern der Zielgruppe(n). Das Feedback fließt in Inhalt und Form Ihrer Architekturdokumentation ein.

Iterativ verfeinern

Ausgehend von den Rückmeldungen justieren wir nach und wiederholen die Schritte wo erforderlich. Wir nehmen weitere Zielgruppen hinzu, ergänzen und vertiefen Inhalte, und bereiten diese in weiteren Formen auf.

Der hier skizzierte Ablauf spielen wir gemeinsam mit Ihrem Team durch, beraten und unterstützen die Mitarbeiter.

 
 

Wann einsetzen?

Das Anfertigen einer Architekturdokumentation unterstützt in verschiedenen Situationen:

  • Ein technischer Proof of Concept soll mit einem größeren Team fachlich umgesetzt werden
  • Eine Architekturvision ist an Entscheider / Projektfremde zu vermitteln
  • Lösungsansätze und Konzepte der Architektur sollen breite Anwendung finden (“Blue Print”)
  • Grundlegende Architekturideen sollen trotz Freiheiten in den Teams eingehalten werden (“Microservices”)
  • Wichtige Know-how-Träger verlassen das Vorhaben oder Unternehmen (“Brain Drain”)

Warum embarc?

Dokumentation unterstützt Kommunikation; unsere Expertise in diesem Bereich kommt daher in vielen unserer Einsätze zum Tragen. So ist es innerhalb Architektur-Reviews typisch, dass ein Architekturüberblick angefertigt oder zumindest geschärft wird.

Mitunter ist Dokumentation aber auch Hauptthema eines Engagements. Wir orientieren uns dabei nicht nur an etablierten Standards wie arc42, sondern gestalten diese aktiv mit.

Unsere Mitarbeiter sind anerkannte Experten für Architekturdokumentation und gleichzeitig exzellente Wissens- und Methodenvermittler: Sie befähigen Ihr Team so in kurzer Zeit prägnante Architekturüberblicke anzufertigen.

Haben wir ihr Interesse geweckt?

Nehmen Sie gern mit uns Kontakt auf oder schicken Sie uns eine E-Mail