Idee di apprendimento attivo
La conclusione di un progetto software non è il codice, ma la sua presentazione e documentazione. In questo modulo, gli studenti imparano a redigere manuali utente chiari e documentazione tecnica accurata, commentando il codice in modo professionale. Si allenano inoltre a esporre le proprie scelte progettuali a un pubblico, distinguendo tra dettagli tecnici per esperti e vantaggi pratici per gli utenti.
Attività 01
Ogni gruppo ha 5 minuti per presentare il proprio progetto alla classe (che agisce come una commissione o dei potenziali investitori), evidenziando il problema risolto e le tecnologie usate.
Perché è importante commentare il codice e redigere una documentazione tecnica?
Attività 02
I gruppi si scambiano il software e il manuale utente. Devono provare a usare il programma seguendo solo le istruzioni scritte, segnalando i punti del manuale che risultano poco chiari o incompleti.
Quali elementi non devono mancare in un manuale utente?
Attività 03
Vengono mostrati esempi di codice ben commentato e male commentato. Gli studenti devono dedurre le 'regole d'oro' per scrivere commenti utili (non descrivere COSA fa il codice, ma PERCHÉ lo fa).
Come si comunica efficacemente il valore di un progetto software a un pubblico non tecnico?
Alcune note per insegnare questa unità
Attenzione a questi errori comuni
Credere che il codice 'si spieghi da solo' se è scritto bene.
Anche il codice migliore ha bisogno di contesto. La documentazione serve a chi riprenderà in mano il progetto dopo mesi, inclusi gli stessi autori. Analizzare progetti open source aiuta a capire l'importanza degli standard di documentazione.
Pensare che la documentazione tecnica e il manuale utente siano la stessa cosa.
Hanno destinatari diversi: il tecnico vuole sapere come funzionano le funzioni; l'utente vuole sapere come raggiungere i suoi obiettivi. Esercizi di scrittura mirata aiutano a distinguere i registri comunicativi.
Metodologie usate in questo brief
Ciclo di vita del software e progettazione
Fasi dello sviluppo di un'applicazione: dall'analisi dei requisiti alla progettazione logica. Utilizzo di diagrammi di flusso e pseudocodice per pianificare la soluzione.
8 methodologies
Tecniche di debugging e testing
Metodologie per l'individuazione e la correzione degli errori (sintattici, logici, di runtime). Creazione di casi di test per verificare la robustezza del programma.
8 methodologies