Legjobb válasz
Ha UML-t (a legelterjedtebben használt diagramokat) fog használni a létrehozáshoz az Ön szoftverarchitektúrája, Visual Paradigm közösségi kiadás egy teljesen ingyenes megoldás (személyes és nem -Commercial).
Támogatja az UML 2.5 diagramokat (itt van egy MVC Framework szoftverarchitektúra, amely szekvenciadiagramot használ)
Modell – nézet-vezérlő ( MVC ) az egyik legszélesebb körben használt felhasználói architektúrájú szoftverarchitektúra, amely egy alkalmazást három összekapcsolt részre osztja (modell / nézet és vezérlő). Ez azért történik, hogy az információk belső reprezentációját el lehessen választani az információk megjelenítésének és a felhasználó általi elfogadásának módjától.
Az MVC architektúra leválasztja ezeket a főbb összetevőket, lehetővé téve a kód újrafelhasználását és párhuzamos fejlesztését a Az internetes és asztali alkalmazásokhoz egyaránt alkalmas aggályok elkülönítése.
Például: JHispter az MVC keretrendszer (a REST API-val együtt) A webalkalmazások, miközben a legnépszerűbb keretrendszer szintén az MVC-hez tartozik mindenféle alkalmazáshoz.
Az UML-ben szekvenciát használhat ábra az MVC szoftver architektúráját ábrázolja. (Forrás: Visual Paradigm – MVC Framework – Visual Paradigm Community Circle )
- Az entitások a rendszer adatait képviselő objektumok: Ügyfél, Termék, Tranzakció, Kosár stb.
- Határok olyan objektumok, amelyek kapcsolódnak a rendszer szereplőihez: UserInterface, DataBaseGateway, ServerProxy stb.
- A vezérlők olyan objektumok, amelyek közvetítenek a határok és az entitások között.
Ezek a parancsok végrehajtását irányítják. a határtól az entitással és a határobjektumokkal való kölcsönhatással érkezik. A vezérlők gyakran megfelelnek a felhasználási esetek forgatókönyvének, és gyakran szekvenciadiagrammal jelennek meg.
használhatja a sztereotípiákat az élvonalhoz az MVC szekvenciadiagramjában. vizuálisan tisztázni, hogy milyen típusú objektumokat használ az MVC-ben
MVC-sorrenddiagram létrehozása ingyenes UML eszközzel
További információ az UML-diagramokról
További információ a sorrenddiagramokról
Válasz
Az architektúrák (vagy még részletesebb, alacsonyabb szintű tervek) dokumentálásakor általánosan alkalmazott magas szintű megközelítés a következő:
- Határozza meg a tervezés érdekeltjeit. A mérnöki / fejlesztői csapat az egyik érdekelt fél. A tesztelési / minőségbiztosítási csapata, az informatikai infrastruktúra csapata, a projektmenedzsment és esetleg a támogató személyzet is érdekelt lehet a rendszerben, és érdeklődhet a tervezés különféle aspektusai iránt. Ha a rendszer rendelkezik adatbázissal, akkor az egyik nézőpont az adatbázis-struktúra. Ha elosztott rendszere van, akkor a rendszergazdákat vagy az ügyfélszolgálat munkatársait érdekelheti az alkatrészek telepítése. Ha van nyilvános felülete, akkor a külső fejlesztőket érdekli, hogy mi is ez a felület – fájlformátumok, adatformátumok stb. Ha sok összetett algoritmusa van, akkor az algoritmustervezőket / karbantartókat a munkafolyamatok és az algoritmuslépések érdeklik. Minden azonosított nézőpont sajátos aggodalomra ad okot.
- Minden egyes nézőponthoz válassza ki a megfelelő ábrázolást. Az adatbázis szempontjából lehet, hogy az entitás-kapcsolat diagramok és az adatszótár hasznosak lehetnek. Nyilvános felületeknél XML séma dokumentumok vagy API dokumentáció szerepelhetnek a dokumentáció részeként. Bonyolult algoritmusok esetén vegye figyelembe az UML tevékenység vagy interakció áttekintő diagramokat. Ha egy jelölést választ, akkor inkább a jól ismert és jól definiált jelöléseket részesítem előnyben, hogy ne kelljen másnak elmagyaráznom a jelölésemet, és egyszerűen a meglévő referenciaanyagra mutathatom, ha nem ismerik a használt szimbólumokat. / li>
- Szöveges leírást és racionális szöveget adjon az ábrák köré. Ne csak magyarázza el, milyen építészeti döntéseket hozott, hanem mi ösztönözte Önt e döntések meghozatalára.
Építészeti keretek, például a Zachman Framework, a The Open Group Architectural Framework, a Department of A Defense Architectural Framework és más építészeti keretrendszerek segítenek meghatározni az alapvetõ szempontokat és nézeteket, amelyek általánosan alkalmazhatók.
Végül a “legjobb” dokumentáció az, amely megfelel az érdekelt felek igényeinek.Az első lépés annak meghatározása, kinek és mire van szüksége az információhoz.