Documentar la arquitectura: una introducción

Hola, mi nombre es Vladimir Ivanov y soy arquitecto de software en EPAM. En mi trabajo, constantemente tengo que documentar las soluciones de software que deben crearse. Decidí compartir contigo algunos aspectos de esta actividad, porque a ti también puede resultarle útil.



¿Cómo dibuja diagramas para su software? ¿Qué preguntas deben responder? ¿Por qué dibujar algo en absoluto? Vamos a averiguarlo.





Una de las responsabilidades de un arquitecto de soluciones es documentar la arquitectura para que pueda transmitirse a todas las partes interesadas del proyecto: gerente de proyecto, director de tecnología, patrocinador del proyecto, equipos de desarrollo, control de calidad y otros. Esto es necesario para:



  • comprender de qué componentes consta el sistema;
  • cómo estos componentes se comunican entre sí;
  • cómo y dónde se ubican los diferentes elementos;
  • si el sistema en su conjunto cumple los requisitos.


La falta de esta información puede llevar fácilmente al incumplimiento de los plazos del proyecto, a la realización de horas extraordinarias o a la cancelación.





Foto de ThisisEngineering RAEng / Unsplash



Consideremos ejemplos



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