Architektur dokumentieren: eine Einführung

Hallo, mein Name ist Vladimir Ivanov und ich bin Software-Architekt bei EPAM. In meiner Arbeit muss ich ständig zu erstellende Softwarelösungen dokumentieren. Ich habe beschlossen, einige Aspekte dieser Aktivität mit Ihnen zu teilen, da auch Sie sie möglicherweise nützlich finden.



Wie zeichnen Sie Diagramme für Ihre Software? Welche Fragen sollten sie beantworten? Warum überhaupt etwas zeichnen? Lass es uns herausfinden.





Eine der Aufgaben eines Lösungsarchitekten besteht darin, die Architektur so zu dokumentieren, dass sie allen Projektbeteiligten mitgeteilt werden kann: Projektmanager, CTO, Projektsponsor, Entwicklungsteams, Qualitätssicherung und anderen. Dies ist notwendig, um:



  • verstehen, aus welchen Komponenten das System besteht;
  • wie diese Komponenten miteinander kommunizieren;
  • wie und wo verschiedene Elemente platziert werden;
  • ob das gesamte System die Anforderungen erfüllt.


Das Fehlen dieser Informationen kann leicht zu versäumten Projektterminen, Überstunden oder Stornierungen führen.





Foto von ThisisEngineering RAEng / Unsplash



Betrachten wir Beispiele



. , , — - , . , . , - , , . Ghost CMS, MySQL; - Apache. -, http https CMS. CMS , , . GCP . , -, . . , :





- , , :



  • . - , .
  • . , , : ; ; ; . .
  • . . , ? ?


(views) “ ”(viewpoints), " " SEI, . :



  1. .
  2. , .
  3. , , , .

    (- -, C4 . .), , . , .




— , ( ):

· ,

· ,

· ,

· -,

· .



:





, : . , :



?





(Context Diagram, C4), , . "". , , , , ​​ .



?





Deployment Diagram



, Google, , IAM. , (20-30 ), , . , .

, , .

, . , .



?





, CMS . , - , . , CMS .

, .





, Views. , - , , « ». .




All Articles