Rendszerdokumentáció
Adatbázismodell és dokumentációja
Folyamatábrák és Sequence Diagrammok
Képernyőtervek és Drótvázak
Felhasználói dokumentáció
Adatbázismodell és dokumentációja
Az adatbázis szerkezete kulcsfontosságú. A dokumentációt "docs as code" szemlélettel készítjük: a struktúra és mezőszintű leírás közvetlenül az adatbázisban található kommentekből generálódik, így mindig naprakész marad.
Folyamatábrák és Sequence Diagrammok
A rendszer működését átlátható, webes szekvenciadiagramokkal szemléltetjük, amelyek megmutatják az egyes komponensek és modulok közötti adat- és folyamatáramlást.
Képernyőtervek és Drótvázak
Az alkalmazás UI-ját drótvázakon keresztül mutatjuk be, részletes leírással kiegészítve. A képernyőtervekhez kapcsoljuk az üzleti logikát és az adatbázisstruktúrákat is, hogy teljes képet kapjunk a működésről.
Felhasználói dokumentáció
A végfelhasználók számára készített kézikönyv is a dokumentáció része, szintén "docs as code" megközelítéssel. Ennek frissítése a release folyamat része, így minden verzióhoz pontos dokumentáció társul.
Az adatbázis szerkezete kulcsfontosságú. A dokumentációt "docs as code" szemlélettel készítjük: a struktúra és mezőszintű leírás közvetlenül az adatbázisban található kommentekből generálódik, így mindig naprakész marad.
Folyamatábrák és Sequence Diagrammok
A rendszer működését átlátható, webes szekvenciadiagramokkal szemléltetjük, amelyek megmutatják az egyes komponensek és modulok közötti adat- és folyamatáramlást.
Képernyőtervek és Drótvázak
Az alkalmazás UI-ját drótvázakon keresztül mutatjuk be, részletes leírással kiegészítve. A képernyőtervekhez kapcsoljuk az üzleti logikát és az adatbázisstruktúrákat is, hogy teljes képet kapjunk a működésről.
Felhasználói dokumentáció
A végfelhasználók számára készített kézikönyv is a dokumentáció része, szintén "docs as code" megközelítéssel. Ennek frissítése a release folyamat része, így minden verzióhoz pontos dokumentáció társul.
A Pistivel való munka rendkívül gördülékeny volt, nagyrészt Pisti rugalmasságának és szakmai hozzáértésének köszönhetően. A projekt nagyon sokszor neki köszönhetően állt a helyes irányba.”
Varga BenceRendszerszervező - CIB bank