Risposta migliore
Se intendi utilizzare UML (i diagrammi più utilizzati) per creare la tua architettura software, Visual Paradigm Community Edition è una soluzione totalmente gratuita (per uso personale e non -Commercial).
Supporta i diagrammi UML 2.5 (qui è unarchitettura software MVC Framework che utilizza il diagramma di sequenza)
Model – view – controller ( MVC ) è uno dei framework di architettura software più utilizzati per lo sviluppo di interfacce utente che divide unapplicazione in tre parti interconnesse (modello / vista e controller). Questo viene fatto per separare le rappresentazioni interne delle informazioni dal modo in cui le informazioni vengono presentate e accettate dallutente.
Larchitettura MVC disaccoppia questi componenti principali consentendo un riutilizzo efficiente del codice e lo sviluppo parallelo utilizzando il concetto di separazione delle preoccupazioni adatta sia per lapplicazione Web che per quella desktop.
Ad esempio: JHispter è il framework MVC (insieme allAPI REST) per Le applicazioni web, mentre i più popolari framework Spring appartengono anche a MVC per tutti i tipi di applicazioni.
In UML, puoi usare una sequenza diagramma per rappresentare larchitettura del software MVC. (Fonte: Visual Paradigm – MVC Framework – Visual Paradigm Community Circle )
- Le entità sono oggetti che rappresentano i dati di sistema: Cliente, Prodotto, Transazione, Carrello, ecc.
- Confini sono oggetti che si interfacciano con attori del sistema: UserInterface, DataBaseGateway, ServerProxy, ecc.
- I controlli sono oggetti che mediano tra confini ed entità.
Orchestrano lesecuzione dei comandi proveniente dal confine interagendo con entità e oggetti di confine. I controlli spesso corrispondono a scenari di casi duso e spesso sono rappresentati da un diagramma di sequenza.
Puoi utilizzare stereotipi per la linea di vita nel diagramma di sequenza MVC per rendere visivamente chiaro il tipo di oggetti che stai utilizzando nellMVC
Per creare un diagramma di sequenza MVC con lo strumento UML gratuito
Scopri di più sui diagrammi UML
Ulteriori informazioni sui diagrammi di sequenza
Risposta
Lapproccio di alto livello che generalmente adotto quando si documentano architetture (o anche progetti più dettagliati, di livello inferiore) è:
- Identificare gli stakeholder di progettazione. Il team di ingegneria / sviluppo è uno degli stakeholder. Anche il team di test / controllo qualità, il team dellinfrastruttura IT, la gestione del progetto e forse il personale di supporto possono essere parti interessate del sistema e interessati a vari aspetti della progettazione.
- Identificare le aree di interesse nel sistema. Se il tuo sistema ha un database, un punto di vista è la struttura del database. Se si dispone di un sistema distribuito, gli amministratori di sistema o il personale del servizio clienti potrebbero essere interessati a sapere dove vengono installati i componenti. Se si dispone di uninterfaccia pubblica, gli sviluppatori esterni sono interessati a cosa sia quellinterfaccia: formati di file, formati di dati, ecc. Se si hanno molti algoritmi complessi, i progettisti / manutentori di algoritmi sono interessati ai flussi di lavoro e ai passaggi dellalgoritmo. Ogni punto di vista che identifichi è un insieme specifico di preoccupazioni.
- Per ogni punto di vista che hai, scegli una rappresentazione appropriata. Per il punto di vista del database, forse possono essere utili i diagrammi di relazione tra entità e un dizionario dei dati. Per le interfacce pubbliche, è possibile includere documenti XML Schema o documentazione API come parte della documentazione. Per algoritmi complessi, considera i diagrammi di panoramica dellattività o dellinterazione UML. Quando scegli una notazione, preferisco notazioni ben note e ben definite in modo da non dover spiegare la mia notazione a qualcun altro e posso semplicemente indirizzarli a materiale di riferimento esistente se non conoscono i simboli usati.
- Aggiungi descrizioni testuali e razionali attorno ai diagrammi. Spiega non solo quali sono state le decisioni architetturali che hai preso, ma cosa ti ha spinto a prendere tali decisioni.
Framework architettonici, come Zachman Framework, The Open Group Architectural Framework, il Dipartimento di Defense Architectural Framework e altri framework architettonici aiutano a definire punti di vista essenziali e punti di vista generalmente applicabili.
In definitiva, “la migliore” documentazione è quella che soddisfa le esigenze delle parti interessate.Identificare chi ha bisogno delle informazioni e di cosa ha bisogno esattamente è il primo passo.