Mejor respuesta
Si va a utilizar UML (los diagramas más utilizados) para crear su arquitectura de software, Visual Paradigm Community Edition es una solución totalmente gratuita (para personal y no -Comercial).
Soporta diagramas UML 2.5 (aquí hay una arquitectura de software MVC Framework usando un diagrama de secuencia)
Modelo – vista – controlador ( MVC ) es uno de los marcos de arquitectura de software más utilizados para desarrollar interfaces de usuario que divide una aplicación en tres partes interconectadas (modelo / vista y controlador). Esto se hace para separar las representaciones internas de la información de las formas en que la información se presenta y acepta al usuario.
La arquitectura MVC desacopla estos componentes principales, lo que permite la reutilización eficiente del código y el desarrollo paralelo utilizando el concepto de separación de preocupaciones que es adecuada para aplicaciones web y de escritorio.
Por ejemplo: JHispter es el marco MVC (junto con la API REST) para Las aplicaciones web, mientras que el framework Spring más popular también pertenece a MVC para todo tipo de aplicaciones.
En UML, puede usar una secuencia diagrama para representar su arquitectura de software MVC. (Fuente: Visual Paradigm – MVC Framework – Visual Paradigm Community Circle )
- Las entidades son objetos que representan datos del sistema: cliente, producto, transacción, carrito, etc.
- Límites son objetos que interactúan con los actores del sistema: UserInterface, DataBaseGateway, ServerProxy, etc.
- Los controles son objetos que median entre los límites y las entidades.
Ellos orquestan la ejecución de comandos procedente de la frontera interactuando con la entidad y los objetos de la frontera. Los controles a menudo corresponden al escenario de casos de uso y, a menudo, se representan mediante un diagrama de secuencia.
Puede usar estereotipos para la línea de vida en el diagrama de secuencia MVC para aclarar visualmente qué tipo de objetos está utilizando en el MVC
Para crear un diagrama de secuencia MVC con la herramienta UML gratuita
Comprenda más acerca de los diagramas UML
Obtenga más información sobre los diagramas de secuencia
Responder
El enfoque de alto nivel que generalmente adopto al documentar arquitecturas (o incluso diseños de nivel inferior más detallados) es:
- Identificar a los interesados en el diseño. El equipo de ingeniería / desarrollo es una de las partes interesadas. Su equipo de prueba / aseguramiento de la calidad, el equipo de infraestructura de TI, la administración del proyecto y tal vez el personal de apoyo también pueden ser partes interesadas del sistema e interesadas en varios aspectos del diseño.
- Identifique las áreas de interés en su sistema. Si su sistema tiene una base de datos, un punto de vista es la estructura de la base de datos. Si tiene un sistema distribuido, los administradores del sistema o el personal de servicio al cliente pueden estar interesados en dónde están instalados los componentes. Si tiene una interfaz pública, los desarrolladores externos están interesados en cuál es esa interfaz: formatos de archivo, formatos de datos, etc. Si tiene muchos algoritmos complejos, los diseñadores / mantenedores de algoritmos están interesados en los flujos de trabajo y los pasos del algoritmo. Cada punto de vista que identifica es un conjunto específico de preocupaciones.
- Para cada punto de vista que tenga, elija una representación adecuada. Para el punto de vista de su base de datos, quizás sean útiles los diagramas entidad-relación y un diccionario de datos. Para las interfaces públicas, se pueden incluir documentos de esquema XML o documentación de API como parte de su documentación. Para algoritmos complejos, considere los diagramas de descripción general de interacción o actividad UML. Cuando eliges una notación, prefiero las notaciones bien conocidas y bien definidas para no tener que explicar mi notación a otra persona y simplemente señalarles el material de referencia existente si no conocen los símbolos utilizados.
- Agrega descripciones textuales y racionales alrededor de los diagramas. Explique no solo cuáles fueron las decisiones arquitectónicas que tomó, sino qué lo impulsó a tomar esas decisiones.
Marcos arquitectónicos, como Zachman Framework, The Open Group Architectural Framework, el Departamento de Defense Architectural Framework y otros marcos arquitectónicos ayudan a definir puntos de vista esenciales y puntos de vista que son generalmente aplicables.
En última instancia, «la mejor» documentación es la que satisface las necesidades de las partes interesadas.Identificar quién necesita la información y qué es exactamente lo que necesita es el primer paso.