Meilleure réponse
Si vous comptez utiliser UML (les diagrammes les plus utilisés) pour créer votre architecture logicielle, Visual Paradigm Community Edition est une solution totalement gratuite (pour les particuliers et non -Commercial).
Supporte les diagrammes UML 2.5 (voici une architecture logicielle MVC Framework utilisant un diagramme de séquence)
Model-view-controller ( MVC ) est lun des frameworks darchitecture logicielle les plus largement utilisés pour développer des interfaces utilisateur qui divise une application en trois parties interconnectées (modèle / vue et contrôleur). Ceci est fait pour séparer les représentations internes des informations de la manière dont les informations sont présentées à lutilisateur et acceptées par celui-ci.
Larchitecture MVC découpe ces composants majeurs permettant une réutilisation efficace du code et un développement parallèle en utilisant le concept de séparation des problèmes qui convient à la fois aux applications Web et aux applications de bureau.
Par exemple: JHispter est le framework MVC (avec lAPI REST) pour Les applications Web, tandis que le framework Spring le plus populaire appartient également à MVC pour toutes sortes dapplications.
En UML, vous pouvez utiliser une séquence diagramme pour représenter votre architecture logicielle MVC. (Source: Visual Paradigm – MVC Framework – Visual Paradigm Community Circle )
- Les entités sont des objets représentant des données système: Client, Produit, Transaction, Panier, etc.
- Limites sont des objets qui sinterfacent avec les acteurs du système: UserInterface, DataBaseGateway, ServerProxy, etc.
- Les contrôles sont des objets qui servent dintermédiaire entre les limites et les entités.
Ils orchestrent lexécution des commandes provenant de la frontière en interagissant avec des objets dentité et de frontière. Les contrôles correspondent souvent à des scénarios dutilisation et sont souvent représentés par un diagramme de séquence.
Vous pouvez utiliser des stéréotypes pour la ligne de vie dans le diagramme de séquence MVC pour rendre visuellement clair le type dobjets que vous utilisez dans MVC
Pour créer un diagramme de séquence MVC avec loutil UML gratuit
En savoir plus sur les diagrammes UML
En savoir plus sur les diagrammes de séquence
Réponse
Lapproche de haut niveau que jadopte généralement lorsque je documente des architectures (ou même des conceptions de niveau inférieur plus détaillées) est:
- Identifier les parties prenantes de la conception. Léquipe dingénierie / développement est une partie prenante. Votre équipe de test / assurance qualité, votre équipe dinfrastructure informatique, la gestion de projet et peut-être le personnel de support peuvent également être des parties prenantes du système et intéressées par divers aspects de la conception.
- Identifiez les domaines de préoccupation de votre système. Si votre système dispose dune base de données, un point de vue est la structure de la base de données. Si vous disposez dun système distribué, les administrateurs système ou le personnel du service client peuvent être intéressés par lemplacement dinstallation des composants. Si vous avez une interface publique, les développeurs externes sintéressent à ce quest cette interface – formats de fichiers, formats de données, etc. Si vous avez de nombreux algorithmes complexes, les concepteurs / mainteneurs dalgorithmes sont intéressés par les flux de travail et les étapes de lalgorithme. Chaque point de vue que vous identifiez est un ensemble spécifique de préoccupations.
- Pour chaque point de vue que vous avez, choisissez une représentation appropriée. Pour le point de vue de votre base de données, des diagrammes dentité-relation et un dictionnaire de données peuvent être utiles. Pour les interfaces publiques, les documents de schéma XML ou la documentation API peuvent être inclus dans votre documentation. Pour les algorithmes complexes, considérez lactivité UML ou les diagrammes daperçu des interactions. Lorsque vous choisissez une notation, je préfère des notations bien connues et bien définies afin de ne pas avoir besoin dexpliquer ma notation à quelquun dautre et de pouvoir simplement les diriger vers des documents de référence existants sils ne connaissent pas les symboles utilisés.
- Ajoutez des descriptions textuelles et rationnelles autour des diagrammes. Expliquez non seulement quelles étaient les décisions architecturales que vous avez prises, mais ce qui vous a poussé à prendre ces décisions.
Les cadres architecturaux, tels que Zachman Framework, The Open Group Architectural Framework, le département de Defence Architectural Framework et dautres cadres architecturaux aident en définissant des points de vue et des vues essentiels qui sont généralement applicables.
En fin de compte, la «meilleure» documentation est celle qui répond aux besoins des parties prenantes.La première étape consiste à identifier qui a besoin des informations et de quoi ils ont exactement besoin.