Diagrammi UML per piccoli progetti

Naviga le tue risposte
2

Tutto ad un tratto la necessità di una corretta documentazione formale è diventata una cosa nella nostra organizzazione. Un sacco di lavoro che faccio sono miglioramenti e aggiunte a un sistema esistente. Generalmente una soluzione rapida o un nuovo metodo, ecc.

Non sono sicuro del tipo di diagrammi che dovrei / potrei usare per i piccoli progetti. Ad esempio, aggiungo una nuova funzionalità a un sistema esistente che verifica il formato di un campo e vogliono una corretta "Descrizione di progettazione del componente con diagrammi" per una semplice regex che verifica il formato di un campo. In passato facevamo solo uno pseudocodice e questo era sufficiente per progetti come il sistema è in qualche modo legacy con pochissima documentazione originale.

    
posta Hameed 08.03.2013 - 04:15
fonte

3 risposte

3

Il tuo problema principale sembra essere che i diagrammi UML documentano sistemi , non progetti . È infatti del tutto assurdo pretendere la documentazione UML separata per un progetto che consiste nell'aggiungere una piccola quantità di funzionalità a un sistema esistente di grandi dimensioni.

Parlate con il vostro management su come questa discrepanza può essere risolta. Se tutto ciò che vogliono è qualche sorta di "documentazione formale", proponi un modulo standardizzato per gestire tali progetti "piccoli cambiamenti" (con voci come "sistema da modificare", "riassunto delle modifiche", "beni interessati", ecc.). Se insistono su UML puramente per la compatibilità buzzword, un documento caso d'uso (non diagramma) è abbastanza simile a quello e può soddisfare la domanda.

In alternativa o in aggiunta, potresti prendere in considerazione creare una documentazione UML di alto livello per quei progetti legacy e integrare i cambiamenti futuri in questo.

    
risposta data 08.03.2013 - 13:38
fonte
2

Sembra che il tuo codice esistente non sia realmente documentato, quindi mentre correggi il codice, dovresti documentare tutto il prodotto finale, non solo le tue cose. Se cambi codice già documentato, dovresti aggiornare la documentazione per assicurarti che sia ancora accurato.

    
risposta data 08.03.2013 - 05:09
fonte
1

Ad esempio, aggiungo una nuova funzionalità a un sistema esistente che verifica il formato di un campo e vogliono il corretto ...
puoi provare il diagramma del caso d'uso

È difficile definire cosa sia un piccolo progetto, a volte si può progettare un piccolo componente ma può risultare che il componente essere usato in altri 100 progetti, ma qui il mio piccolo tentativo
Per piccoli progetti diagrammi come user-case, class, activity, sequence & diagramma di stato può fare il lavoro.

Se stai utilizzando intellij per lo sviluppo, allora ctrl + alt + shift + u sul pacchetto e questo genererà automaticamente il diagramma delle classi per te

    
risposta data 08.03.2013 - 12:07
fonte

Leggi altre domande sui tag

Come gestire User Story alla fine dello sprint se gli utenti vogliono modifiche? Oltre alle macro, esistono altre tecniche di metaprogrammazione? [duplicare]