Documenter l'architecture: une introduction

Bonjour, je m'appelle Vladimir Ivanov et je suis architecte logiciel chez EPAM. Dans mon travail, je dois constamment documenter les solutions logicielles qui doivent être créées. J'ai décidé de partager certains aspects de cette activité avec vous, car vous pourriez aussi la trouver utile.



Comment dessinez-vous des schémas pour votre logiciel? À quelles questions doivent-ils répondre? Pourquoi dessiner quoi que ce soit? Découvrons-le.





L'une des responsabilités d'un architecte de solution est de documenter l'architecture afin qu'elle puisse être communiquée à toutes les parties prenantes du projet: chef de projet, CTO, commanditaire de projet, équipes de développement, assurance qualité et autres. Ceci est nécessaire pour:



  • comprendre les composants du système;
  • comment ces composants communiquent entre eux;
  • comment et où se trouvent les différents éléments;
  • si le système dans son ensemble répond aux exigences.


Le manque de ces informations peut facilement conduire à des délais de projet manqués, des heures supplémentaires ou une annulation.





Photo de ThisisEngineering RAEng / Unsplash



Prenons des exemples



. , , — - , . , . , - , , . 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