Un README utile: spiegare il primo risultato, non tutto il progetto
DocumentazioneOrganizza un README con scopo, prerequisiti, primo utilizzo e limiti. Una struttura concreta per chi apre un progetto senza conoscerlo.
Leggi l’articoloDocumentazione software che si può usare
Un programma può funzionare e restare difficile da usare se le istruzioni non spiegano da dove cominciare. Quaderno dei Sistemi affronta questo spazio: nomi dei file, versioni, note di rilascio, segnalazioni e piccoli documenti che rendono un progetto comprensibile a chi lo riprende dopo settimane. Ogni guida propone un risultato concreto, da una scheda di errore a un indice di manuale.
Note di rilascio: cosa cambia per chi usa il programma
VersioniDistingui novità, correzioni, incompatibilità e azioni richieste. Una traccia di note di rilascio leggibile anche senza conoscere il codice.
Leggi l’articolo
Numeri di versione: come leggere major, minor e patch
VersioniComprendi la convenzione SemVer senza presumere che ogni programma la adotti. Con un esempio di cambiamento incompatibile e una lista di controlli.
Leggi l’articolo
Segnalare un errore in modo riproducibile
CollaborazionePrepara una segnalazione con contesto, passi, risultato atteso e risultato osservato. Riduci i dati sensibili e separa i fatti dalle ipotesi.
Leggi l’articolo
Organizzare un manuale software per attività
DocumentazioneTrasforma un indice di pulsanti in percorsi operativi: preparazione, azione e controllo del risultato. Un esempio per un archivio di documenti.
Leggi l’articolo
Nomi dei file: riconoscere documento, versione e stato
ArchiviDefinisci una convenzione leggibile per i documenti di progetto ed evita sequenze di finale, definitivo e nuovissimo senza significato.
Leggi l’articolo
Schermate nei manuali: mostrare il passaggio senza nascondere il testo
DocumentazioneRitaglia le schermate sul compito, descrivi l’azione nel testo e controlla dati sensibili e versione dell’interfaccia.
Leggi l’articolo
Un glossario piccolo per evitare istruzioni contraddittorie
CollaborazioneScegli termini coerenti per azioni, oggetti e stati del software. Un metodo semplice per distinguere sinonimi utili e differenze reali.
Leggi l’articolo
Consegna di un progetto: la checklist dei documenti
ArchiviPrepara una consegna leggibile con versione, istruzioni, file necessari e problemi aperti. Verifica il pacchetto da una cartella separata.
Leggi l’articoloLa pubblicazione è indipendente e non rappresenta la precedente D.E.Ca. System, non distribuisce i suoi prodotti e non offre assistenza sui suoi software. Non tratta verifiche di conformità, certificazione delle macchine o consulenza tecnico-legale. Il tema di questo quaderno è più circoscritto: organizzare informazioni sul software e distinguere ciò che è stato verificato da ciò che resta da controllare. Gli esempi sono costruiti dalla redazione; i riferimenti tecnici rimandano alla documentazione delle piattaforme o delle specifiche citate. Scegli una guida in base al documento che devi preparare, non al nome di uno strumento.