Documentazione del sistema
La documentazione del sistema include una panoramica completa del sistema. Questo documento deve aiutare chiunque a comprendere tutte le considerazioni che sono state prese durante la creazione del sistema. La documentazione del sistema include molto spesso i requisiti, la progettazione dell'architettura, il codice sorgente, le storie degli utenti e le informazioni sui test.
Nella parte dei requisiti del documento, è necessario far partecipare tutti coloro che sono coinvolti nel progetto:
- Membri del team del cliente
- Membri del team di progetto
- Parti interessate
- Chi, presso il cliente, è il proprietario del sistema
La documentazione descrive il motivo per cui si sta creando il sistema, gli obiettivi del progetto e come il sistema si allinea agli obiettivi aziendali del cliente.
È opportuno aggiungere qualsiasi tipo di considerazione propria e del cliente, che si tratti di normative locali o specifiche del settore o di considerazioni tecniche. Queste considerazioni sono importanti perché chiariscono i motivi per cui si è scelto di creare la soluzione in un determinato modo.
Gli utenti tipo e gli scenari per gli utenti devono essere inclusi nella documentazione del sistema. Gli utenti tipo e gli scenari descrivono per chi si crea il sistema e gli scenari che il sistema deve supportare.
Successivamente, si aggiungono le storie degli utenti e i criteri di accettazione di tutte le storie degli utenti. È importante creare la soluzione sulla base di queste storie degli utenti. Non creare mai parti della soluzione che non si possono mappare a una storia dell'utente. I criteri di accettazione indicano quando una storia dell'utente viene accettata e quando l'attività è stata completata.
È sempre utile includere un diagramma dell'architettura della soluzione. Il diagramma deve includere l'aspetto tecnico della soluzione e la posizione della soluzione nel panorama tecnico dell'azienda.
In molte soluzioni Microsoft Dynamics 365, gli sviluppatori di codice coinvolti scrivono codice personalizzato. La documentazione del sistema deve sempre contenere informazioni su tutte le parti del sistema sviluppate dal codice.
Se si imposta un piano di test, assicurarsi di includerlo nella documentazione del sistema. Quindi, è possibile mostrare tutto ciò per cui è stato eseguito il test, chi ha eseguito il test e i risultati.