DQF

Il progetto DQF, dove l’acronimo sta per Documentation Quality Framework, è un nuovo approccio per la valutazione e la garanzia della qualità della documentazione di progetto.

"La documentazione tecnica è parte integrante dell'intero sistema software e asset fondamentale di un sistema di gestione della conoscenza. Essa infatti rappresenta la descrizione della progettazione tecnica, della struttura dei componenti software, delle strutture dati, dei design pattern utilizzati e la documentazione del codice sviluppato al fine di capire, analizzare e modificare un sistema applicativo durante tutto il suo ciclo di vita" (Gartner).

Avere documentazione tecnica di "elevata" qualità è tanto importante quanto avere software di "elevata" qualità.

E’ naturale chiedersi quindi quali siano i motivi per i quali si è portati a dire che la documentazione tecnica risulti importante, ed i principali sono:
• l'apprendimento di un sistema software
• il test di un sistema software
• lavorare su un nuovo sistema software
• risolvere problemi quando gli altri sviluppatori non sono disponibili per rispondere alle domande
• la manutenzione di un sistema software

Ne consegue che la documentazione tecnica non assume valore laddove sia caratterizzata da “scarsa” qualità ovvero:
• Se è oscura e di difficile comprensione.
• Quando è inadeguata ed incompleta.
• Se perde di tracciabilità: è difficile ritrovare le informazioni rilevanti per l'apprendimento del sistema software.
• Quando le modifiche non sono adeguatamente documentate.
• Quando perde di integrità e consistenza.

I principali componenti del framework DQF sono:

Il Modello di Valutazione utilizza gli standard internazionali di documentazione e specifica dei requisiti tecnici e la letteratura scientifica prodotta nell'ambito dell'Ingegneria del Software.

I costi di produzione della documentazione tecnica sono relativamente semplici da quantificare mentre più difficile è quantificare i costi determinati dalla non produzione della documentazione. Nel secondo caso difatti ricadono i costi per la mancata conformità ed i costi di inefficienza dei processi dovuti sia alla perdita di tempo nel coinvolgimento di molti attori sia allo spreco di tempo nella ricerca di informazioni. Inoltre avvalersi di documentazione tecnica di qualità consente di ridurre notevolmente i tempi di risoluzione degli incidenti sui sistemi software.

La soluzione proposta consente di attuare:
• Automazione del processo di controllo lungo la timeline di progetto
• Analisi dei documenti attraverso un controllo formale basato sui template
• Analisi di qualità dei documenti tecnici
• Classificazione e archiviazione dei documenti
• Pianificazione della produzione della documentazione
• Indicazione delle azioni di correzione (controlli formali)
• Indicazione delle azioni di miglioramento della qualità (controlli di qualità)
• Monitoraggio e manutenzione della base di conoscenza documentale