Il Documento di Progetto: a cosa serve e quali informazioni contiene

In un precedente articolo ( “Documento dei requisiti: perchè è importante e cosa scrivere“) abbiamo illustrato perchè è indispensabile mettere nero su bianco i requisiti di un progetto e soprattutto perchè debba essere fatto in maniera strutturata.

In questo articolo invece parleremo del passo successivo, della fase di sviluppo del software in cui, quando a partecipare al progetto è un team di più persone, è necessario rendere l’informazione unica, condivisa e precisa al fine di evitare perdite di tempo e quindi aumentare i costi del progetto. Per ottenere tutto questo ed avere anche una componente scalabile, live ed utile per il Committente per tutto il ciclo di vita del software è necessario scrivere e strutturare opportunamente la “Documentazione di Progetto”.

Ciò avviene in un concetto più ampio di Knowledge Management( ne abbiamo parlato nell’articolo “Knowledge Management e feedback tool online“) in connubio con la pianificazione, progettazione e organizzazione del progetto di sviluppo in linea con framework come Agile e Scrum.

Documento di Progetto: cosa contiene

Il Documento di Progetto deve rappresentare l’elemento di riferimento per qualsiasi sviluppatore anche esterno. Il Documento di progetto parte da una solida base, che di fatto è la linea d’azione del progetto ed i cui contenuti potrebbero essere comuni a diversi progetti ( per es. la metodologia di autenticazione), per poi intervenire nel come verrà sviluppato il progetto: quali framework vengono usati, qual’è la loro architettura, quali sono gli utenti, quali sono i processi ed i workflow. In pratica il Documento di Progetto delinea tutte le componenti di sviluppo, come sono state fatte e come servirsene durante lo sviluppo stesso( per es. come chiamare un API).

Il nostro Documento di Progetto, parte integrante di tutti i software che abbiamo sviluppato, si porta dietro un’esperienza decennale e la traduce in tutte le componenti indispensabili per il successo del software e la garanzia della sua qualità.

All’interno trovi, come minimo, i seguenti argomenti:

• Scopo, Acronimi e Terminologia al fine di illustrare il contesto e farlo comprendere da chiunque lo legga;
• Architettura del Front-End, il framework usato e le best practices implementate, il sistema di autenticazione, gli utenti, i processi di front end e le funzionalità;
• Le comunicazioni remote e come avvengono, le configurazioni delle API, gli Status Code HTTP, i processi delle comunicazioni remote;
• L’architettura del Back-End, quali sono le API disponibili, i parametri per chiamarle ed i meccanismi di controllo, le funzionalità;
• L’architettura del Database, il modello e le relazioni, i meccanismi di High Availability;
• La gestione delle Email e delle comunicazioni esterne;
• La mappa dei permessi e delle autorizzazioni non solo per gli utenti ma anche per i service account, i profili;
• La gestione della Privacy, le modalità di adeguamento a norme come il GDPR ed i processi di controllo;
• L’implementazione della Cyber Security, come sono stati realizzati i principi di Security By Default e Security By Design, i sistemi di auditing e di controllo;
• Il piano dei test, quali, quanti e come sono stati realizzati, le modalità di verifica delle performance e dell’affidabilità.

Come puoi ben comprendere, è un documento complesso e laborioso ma indispensabile se si vuole procedere in maniera strutturata, evitare di reinventare la ruota ogni volta e garantire che ogni sviluppatore abbia le medesime informazioni corrette e strutturate a disposizione.

Attraverso il Documento di Progetto, la qualità del software è certa perchè non può essere sfuggito nulla e sono stati presi in considerazione, analizzati e realizzati tutti gli elementi che permettono di ottenere un software affidabile e sicuro.

Contattaci subito e senza impegno per realizzare la documentazione di progetto del tuo software.

Glue Labs ed i progetti di sviluppo software

Abbiamo realizzato applicazioni per ambienti critici e ti invitiamo a leggere alcuni Case Study. Grazie all’esperienza maturata in tantissimi settori, con numerosi Clienti e con un solido gruppo aziendale ti forniamo supporto nel building e delivery di software in maniera documentata e con garanzia 12 mesi da qualsiasi bug. Contattaci subito e senza impegno per maggiori informazioni.