In alcuni casi è particolarmente utile informare il lettore in merito alle variazioni intercorse sui contenuti.
In tal caso è possibile associare l’articolo ad un dettaglio che sintetizza i cambiamenti.
Cos’è un changelog?
E’ un file che contiene una lista raggruppata per tipologie, ordinata cronologicamente per ogni variazione intervenuta sui contenuti.
Perchè mantenere un changelog?
Per rendere più semplice la lettura di quali sono i cambiamenti intervenuti
Per quali tipologie di contenuti può essere opportuno mantenere un changelog?
Ogni volta che viene aggiornata la versione di un documento potrebbe essere opportuno rendicontare le modifiche introdottte.
E’ ad esempio il caso di strumenti e soluzioni che nel tempo aggiungono o modificano alcune funzionalità.
Può essere utile anche nel caso di un articolo che riassume gli sviluppi di una base di conoscenza, su contenuti, fonti, motivazioni, validità, condizioni, ecc., relative alle variazioni.
Come elaborare un buon changelog?
Principi Guida
- I Changelogs sono destinati agli umani, non alle macchine.
- Dovrebbe essere presente un inserimento per ogni versione.
- Le stesse tipologie di variazioni dovrebbbero essere raggruppate.
- Versioni e sezioni dovrebbero essere linkabili.
- La versione più recentnte dovrebbe essere la prima (ordine temporale decrescente).
- Deve essere indicatta la data di rilascio di ogni versione.
Tipologie di cambiamenti
Added: per le nuove funzionalità/ contenuti/ caratteristiche.Changed: per le modifiche sui contenuti esistenti.Deprecated: per le funzionalità/ contenuti che verranno presto rimossi.Removed: per le funzionalità/ contenuti rimossi.Fixed: per eventuali correzioni di bug.Security: per evidenziare rischi sulle vulnerabilità.
