Quando e perché durante la reingegnerizzazione del software a volte la ricostruzione del documento viene saltata?

2

Mentre studiavo il libro di Ingegneria del software dell'autrice Roger Pressman, mi sono imbattuto in questo punto sulla reingegnerizzazione del software, in cui è scritto nel libro che se la creazione di documentazione richiede molto tempo, allora viene saltata. Roger Pressman dice che se non ci sono cambiamenti significativi dopo la reingegnerizzazione, la creazione della documentazione viene saltata. Ma se prendiamo l'esempio di "javadoc" e se i creatori di javadoc saltano la ristrutturazione della documentazione mentre il nuovo rilascio della versione di java, solo perché non ci sono grandi cambiamenti, potrebbe essere disastroso per l'utente "javadoc". Sono confuso se questa pratica di ingegneria del software è pratica. Qualcuno può collaborare e aiutarmi a capire ciò che Roger Pressman si aspetta qui.

    
posta Deepeshkumar 15.10.2017 - 11:08
fonte

1 risposta

5

La documentazione è più della documentazione di riferimento. Mantenere aggiornati i riferimenti in stile Javadoc o Doxygen è abbastanza semplice perché sono scritti proprio accanto al codice.

Molte documentazioni vivono in documenti completamente separati. Ad esempio, il software dell'utente finale potrebbe avere un manuale. Potrebbero anche esserci documenti interni, come panoramiche dell'architettura, diagrammi UML, documenti di richiesta di modifica o rapporti di verifica.

Tutti questi documenti hanno valore. Ma il loro valore non sempre supera il costo dell'aggiornamento dopo ogni modifica. Per esempio. fare un audit può essere molto costoso, ma potrebbe essere possibile saltarlo per modifiche minori. Se l'architettura non è stata modificata in modo significativo, non è necessario ripetere tutti i diagrammi. Dipende dal processo di sviluppo prescelto, dalle priorità aziendali e dal contesto normativo in base al quale i documenti devono essere aggiornati.

Restando con l'esempio di Java SDK, non c'è solo la documentazione Javadoc. L'SDK contiene anche guide e tutorial esaustivi per parti specifiche della lingua e libreria standard, ad es. una guida attraverso i widget della GUI Swing disponibili. Probabilmente non è necessario aggiornarli per ogni versione di Java perché la libreria e il linguaggio rimangono sostanzialmente gli stessi.

    
risposta data 15.10.2017 - 12:19
fonte

Leggi altre domande sui tag