Il flusso di lavoro essenziale05 / 16
Leggere spiegazioni e prove
In questa pagina
Le spiegazioni dell’implementazione ti aiutano a partire da una parte dell’intento, capire come funziona il codice e trovare le prove a sostegno del resoconto. Concentrati sul comportamento, sui materiali di supporto e sulle domande che richiedono ancora il tuo giudizio.
Apri le spiegazioni del paragrafo e quelle locali
Fai clic sul testo del documento per modificarlo. Fai clic sullo spazio vuoto all’interno di un paragrafo, fuori dal testo, per aprire la spiegazione del paragrafo, contrassegnata come L1.
Alcune spiegazioni riguardano una parola o un’espressione. Passa il puntatore sul paragrafo per vedere brevi sottolineature, poi fai clic su una di esse per leggere la spiegazione locale, contrassegnata come L2.
Anche elenchi, tabelle e blocchi di codice possono avere spiegazioni. Un intero elenco viene indagato insieme; i titoli non vengono indagati autonomamente.
Puoi tenere aperte le note a margine di più paragrafi. Ogni paragrafo mostra una sola spiegazione alla volta, del paragrafo o locale. In una finestra stretta, la nota può comparire sotto il paragrafo.
Leggi le tre sezioni
| Sezione | Domanda a cui risponde | Cosa cercare |
|---|---|---|
| Realizzazione (Realization) | Come risponde l’implementazione a questo intento? | Comportamento, passaggi, casi limite e scelte di implementazione. |
| Prove (Evidence) | Cosa sostiene la spiegazione? | Riferimenti al codice, test, output dei comandi e altri materiali verificabili. |
| Attenzione (Attention) | Cosa richiede un’ulteriore valutazione? | Lacune, scelte di implementazione, rischi e suggerimenti. |
Realizzazione è espansa per impostazione predefinita. Espandi Prove quando serve. Attenzione viene nascosta quando non ci sono aspetti da segnalare.
Per una ricompensa dopo 7 check-in consecutivi, la spiegazione potrebbe descrivere come si accumulano le date, citare la funzione e i test pertinenti e segnalare come vengono gestiti i viaggi tra fusi orari. Il contenuto effettivo dipende dall’indagine sul tuo progetto.
Verifica le prove
I riferimenti al codice aprono i file nell’applicazione predefinita del sistema. Puoi visualizzare e ingrandire le immagini nella nota a margine. Le etichette di materiali come output dei comandi e diff del codice aprono una nuova scheda. Noea ti avvisa se il materiale non è più disponibile.
Chiediti se ogni riferimento risponde alla tua domanda, quali condizioni copre un test e se i risultati sostengono la conclusione. Se manca uno scenario importante, fai una domanda sul paragrafo e richiedi un’ulteriore indagine o verifica.
In particolare, distingui tre tipi di prove:
| Materiale | Cosa aiuta a stabilire | Cosa non stabilisce |
|---|---|---|
| Codice dell’implementazione o dei test | La logica usata e gli scenari definiti dai test. | L’esistenza dei test non significa che siano stati eseguiti o superati. |
| Risultati di esecuzioni precedenti | Cosa è stato eseguito allora e quale risultato ha dato. | Modifiche successive al codice possono rendere quei risultati non più applicabili. |
| Verifiche effettivamente eseguite ora | Il risultato nell’ambiente e nell’ambito di questa esecuzione. | Superare gli scenari coperti non dimostra la correttezza di quelli non verificati. |
Spiega e Indagine normalmente leggono il codice e le prove esistenti, senza rieseguire ogni volta test, build o applicazione. Verificano un fatto quando la sola lettura non permette di stabilire qualcosa di essenziale per il giudizio. Valuta l’ambito delle verifiche da ciò che è stato effettivamente eseguito.
Per rieseguire un test specifico, chiedi all’Agent in chat di eseguirlo e riportarne ambito e risultato, poi indaga di nuovo il paragrafo pertinente.
Decidi quali scelte inserire nell’intento
Una spiegazione che dice “L’implementazione attualmente usa l’archiviazione locale” descrive l’approccio di oggi; non impone alle versioni future di usarlo. I requisiti che vuoi conservare appartengono al documento di intento.
Valuta se una scelta influisce su esperienza d’uso, costi, privacy, rischi o decisioni future. Dopo averla compresa, ci sono due esiti comuni:
- L’approccio attuale va bene e vuoi lasciarti la possibilità di cambiarlo: continua a usarlo senza trasformarlo in un vincolo.
- L’approccio deve restare valido nelle versioni future: scrivi il requisito esplicitamente ed esamina i limiti che introduce.
Per esempio, oggi potresti accettare l’archiviazione locale dei check-in. Se l’uso offline diventa essenziale, scrivi “Gli utenti possono effettuare il check-in anche senza connessione di rete”, poi indaga come l’implementazione sostiene quel comportamento. Esprimere il comportamento richiesto è di solito più facile da mantenere che copiare una descrizione dettagliata dell’implementazione.
Comprendi la sezione Attenzione
Le voci di Attenzione sono classificate come lacune, scelte di implementazione, rischi o suggerimenti. Distinguono i comportamenti mancanti dalle scelte progettuali attuali e dagli argomenti da approfondire.
L’indicatore a destra del paragrafo apre la spiegazione pertinente. Il numero conta i pannelli di spiegazione che contengono segnalazioni, non le singole questioni. Una lacuna rende il colore dell’indicatore più evidente.
Comprendi l’impatto prima di decidere se correggere il codice, aggiungere verifiche, modificare l’intento o mantenere il comportamento attuale. Non ogni segnalazione deve diventare un requisito. L’assenza di indicatori significa soltanto che la spiegazione attuale non elenca segnalazioni.
Esplora le illustrazioni del comportamento
Alcune spiegazioni includono una piccola illustrazione interattiva del comportamento. Puoi provarla, reimpostarla o esaminarne il codice sorgente.
Queste illustrazioni vengono eseguite in una sandbox isolata, senza accesso all’app o alla rete, e non salvano lo stato delle interazioni. Spiegano una regola; per verificare che il software reale la rispetti servono comunque codice e prove di verifica.
Verifica se una spiegazione è ancora valida
Testo precedente (Previous text) significa che la spiegazione riguarda l’intento prima della modifica. Potrebbe non essere aggiornata (May be outdated) significa che i file letti o citati dalla spiegazione sono cambiati dopo l’indagine. Entrambi sono motivi per indagare di nuovo.
Le note a margine sono di sola lettura. Modifica l’intento per cambiare un requisito; usa Indagine o Indaga di nuovo (Investigate Again) per verificare una spiegazione. Consulta Mantenere aggiornate le spiegazioni.