Documentazione di test nel test del software (esempio)

Cos'è la documentazione di prova?

La documentazione di test è la documentazione degli artefatti creati prima o durante il test del software. Aiuta il team di test a stimare lo sforzo richiesto, monitorare le risorse e i progressi e garantire un'adeguata copertura dei test. La registrazione e i report dei test sono una suite completa di documenti che consentono di descrivere e documentare la pianificazione, la progettazione, l'esecuzione e i risultati dei test derivanti dall'attività di test.

👉 Iscriviti al progetto di test software live gratuito

Perché è necessaria la formalità dei test?

Per un principiante, è facile presumere che il testing consista nell'eseguire le varie sezioni di codice in modo mirato e verificarne i risultati. Ma nel mondo reale, il testing è un'attività molto formale e documentata in dettaglio. La documentazione dei test semplifica e rende verificabili la pianificazione, la revisione e l'esecuzione dei test.

Il grado di formalità del test dipende da:

• Il tipo di applicazione in fase di test (AUT).
• Standard seguiti dalla vostra organizzazione.
• La maturità del processo di sviluppo.

Le attività di test in genere consumano tra 30% e 50% dello sforzo totale di sviluppo del software. La documentazione aiuta a identificare i miglioramenti del processo di test che possono essere applicati a progetti futuri.

Quali sono i tipi di documentazione dei test?

Ecco i tipi importanti di documentazione di prova:

“In pratica, questi documenti vengono creati in fasi diverse: dalla pianificazione iniziale (politica di test, strategia) all'esecuzione e alla chiusura (report sui difetti e di riepilogo).”

Tipi di documenti di test	Descrizione
Politica di prova	Si tratta di un documento di alto livello che descrive i principi, i metodi e tutti gli obiettivi di test più importanti dell'organizzazione.
Strategia di prova	Un documento di alto livello che identifica i livelli (tipi) di test da eseguire per il progetto.
Piano di test	Un piano di test è un documento di pianificazione completo che contiene l'ambito, l'approccio, le risorse, la pianificazione, ecc. delle attività di test.
Matrice di tracciabilità dei requisiti	Si tratta di un documento che collega i requisiti ai casi di test.
Scenario di prova	Scenario di prova è un elemento o un evento di un sistema software che potrebbe essere verificato da uno o più casi di test.
Test Case	Si tratta di un gruppo di valori di input, precondizioni di esecuzione, postcondizioni di esecuzione previste e risultati. È sviluppato per uno scenario di test.
Dati di test	I dati di test sono dati esistenti prima dell'esecuzione del test. Vengono utilizzati per eseguire il caso di test.
Rapporto sui difetti	Un rapporto sui difetti è un rapporto documentato di qualsiasi difetto in un sistema software che non riesce a svolgere la funzione prevista.
Rapporto riepilogativo del test	Il rapporto riassuntivo del test è un documento di alto livello che riassume le attività di test svolte e i risultati dei test.

Quali sono le migliori pratiche per ottenere la documentazione dei test?

In questa sezione, apprenderemo le best practice che aiutano a realizzare la documentazione dei test, con esempi che ti aiuteranno a comprenderla meglio:

• Coinvolgere il QA fin dalle prime fasi del progetto: Coinvolgere il team QA fin dall'inizio del progetto, in modo che la documentazione dei test venga sviluppata parallelamente alla progettazione e ai requisiti del prodotto.
  Esempio: Il QA collabora durante la pianificazione dello sprint per redigere i casi di test iniziali basati sulle storie degli utenti.
• Mantieni aggiornati i documenti: Non limitarti a creare documenti di prova e poi dimenticartene: aggiornali ogni volta che cambiano requisiti o funzionalità.
  Esempio: Quando un'API di accesso cambia, aggiorna immediatamente i casi di test e i risultati correlati.
• Utilizzare il controllo della versione: Gestire e monitorare tutte le modifiche apportate ai documenti di prova tramite sistemi di controllo delle versioni per evitare confusione e perdita di dati.
  Esempio: Archivia i piani di test su GitHub per mantenere una cronologia delle versioni chiara e le opzioni di rollback.
• Documento per chiarezza e scopo: Registra solo ciò che aiuta te e i tuoi stakeholder a comprendere i progressi e i risultati dei test.
  Esempio: Includere report riepilogativi dei test che evidenziano i casi di test superati, non superati e bloccati per la revisione della direzione.
• Utilizzare modelli standard: Utilizzare un formato coerente, ad esempio modelli Excel o Word, per semplificare la creazione e la revisione della documentazione.
  Esempio: Utilizzare un "modello di caso di test" standard con campi per ID, descrizione, precondizioni e risultati previsti.
• Archiviazione centralizzata dei documenti: Conserva tutti i documenti relativi al progetto in un unico luogo accessibile per garantire che i membri del team possano consultarli o aggiornarli facilmente.
  Esempio: Memorizza gli artefatti di prova in un ambiente condiviso Google Drive cartella accessibile all'intero team QA e di sviluppo.
• Includi dettagli sufficienti: Evitare informazioni vaghe o incomplete; una documentazione dettagliata migliora la comprensione e riduce gli errori durante l'esecuzione dei test.
  Esempio: Invece di "Verifica accesso", scrivi "Verifica accesso utente con credenziali valide reindirizza alla dashboard correttamente".

Quando è opportuno creare la documentazione di test per i test del software?

Ecco alcuni punti chiave su quando dovresti creare la documentazione di test per il test del software:

• Fase di pianificazione: Prima di iniziare l'esecuzione del test, definire chiaramente ambito, obiettivi e strategia di test.
• Preparazione al test: Durante la pianificazione dei test, per stabilire in modo efficiente tempi, risorse e requisiti ambientali.
• Analisi dei requisiti: Dopo l'analisi dei requisiti, per garantire la copertura completa delle specifiche funzionali e non funzionali.
• Standardizzazione della progettazione: Prima di progettare i casi di test, standardizzare i formati e mantenere la tracciabilità in tutti i documenti.
• Documentazione dello scenario: Durante la progettazione del test, per documentare scenari, input, output previsti e dettagli sui dati di test.
• Prontezza all'esecuzione: Prima dell'esecuzione del test, per verificare la prontezza dell'ambiente di test, degli strumenti e l'accuratezza della documentazione.
• Valutazione post: Dopo i test, registrare i risultati, i difetti e le lezioni apprese per migliorare il processo.

Quali tipi di modelli sono richiesti per la documentazione dei test?

Ecco alcuni modelli necessari per la documentazione dei test nei test del software:

Nome modello	Strumenti
Modello del piano di test	Microsoft Word, Google Docs, o Confluence per la modifica collaborativa e il controllo delle versioni
Modello di caso di prova	TestRail, Zephyr (in JIRA), Xray o Excel/Google Sheets per la gestione strutturata dei test
Modello di scenario di prova	JIRA, TestLink o Google Sheets per documentare le condizioni di test di alto livello
Modello di matrice di tracciabilità dei requisiti (RTM)	Excel, Google Sheets o TestRail per mappare i requisiti sui casi di test
Modello di rapporto sui difetti	JIRA, Bugzilla o Azure DevOps per la registrazione e il monitoraggio dei difetti
Modello di report di riepilogo del test	Confluenza, Google Docs, o TestRail per la compilazione dei risultati dei test e l'analisi

Pro e contro della documentazione dei test

Vantaggi

• Lo scopo principale della creazione della documentazione di test è ridurre o eliminare qualsiasi incertezza sulle attività di test. Contribuisce a eliminare l'ambiguità che spesso si verifica quando si tratta di assegnare i compiti.
• La documentazione non offre solo un approccio sistematico a test del software, ma funge anche da materiale didattico per i principianti nel processo di test del software.
• Presentare la documentazione dei test per dimostrare un processo di test maturo è una buona strategia di marketing e vendita.
• La documentazione dei test ti aiuta a offrire al cliente un prodotto di qualità entro limiti di tempo specifici.
• In Software Engineering, la documentazione di prova aiuta anche a configurare o impostare il programma tramite il documento di configurazione e i manuali dell'operatore.
• La documentazione dei test ti aiuta a migliorare la trasparenza con il cliente.

Svantaggi

• Il costo della documentazione potrebbe superare il suo valore in quanto richiede molto tempo.
• Spesso sono scritti da persone che non sanno scrivere bene o che non conoscono la materia.
• Tenere traccia delle modifiche richieste dal cliente e aggiornare i documenti corrispondenti è faticoso.
• Una documentazione scadente riflette direttamente la qualità del prodotto, poiché può verificarsi un malinteso tra il cliente e l'organizzazione.

Errori comuni da evitare nella documentazione dei test

Ecco gli errori più comuni da evitare nella documentazione di un test:

1. Evitare di scrivere descrizioni dei casi di test poco chiare o ambigue.
2. Non tralasciare la documentazione delle precondizioni e delle dipendenze dei test.
3. Non dimenticare mai di includere i risultati previsti per ogni test.
4. Evitare formattazioni incoerenti nei diversi documenti di prova.
5. Non utilizzare obiettivi di test vaghi o non misurabili.
6. Non omettere mai il controllo della versione per gli aggiornamenti della documentazione di prova.
7. Evitare di duplicare le informazioni su più artefatti di test.
8. Non trascurare di verificare l'accuratezza e la completezza della documentazione.

Domande Frequenti