ändringslogg

En ändringslogg är en dokumentation som listar förändringar som gjorts i ett projekt, en produkt eller ett dokument över tid. Den används för att informera användare, kunder och utvecklare om vad som har ändrats sedan senaste version. Begreppet förekommer ofta som changelog eller release notes i olika sammanhang, särskilt inom mjukvaruutveckling.

Innehåll och struktur i en ändringslogg varierar, men vanligt förekommande poster inkluderar versionnummer, utgivningsdatum, en kort sammanfattning av förändringen, typ av ändring (ny funktion, förbättring, buggfix, säkerhetsåtgärd), berörda komponenter och länkar till ärenden eller bugs i spårningssystem. I vissa fall anges även påverkan eller risknivå samt ansvarig team eller utvecklare. Målet är att ge tydlig kontext så att mottagare förstår vad som är nytt, ändrat eller åtgärdat.

Användning och placering varierar också. En ändringslogg lagras ofta tillsammans med källkoden i en repository som CHANGELOG.md eller i release-anteckningar som följs vid varje utgivning. Den kan vara riktad mot externa användare (offentlig logg) eller användas internt inom organisationen. Förutom att beskriva vad som ändrats fungerar loggen som ett stöd för när och varför vissa uppsättningar av funktioner introducerades, vilket underlättar vidare utveckling och dokumentation.

Bästa praxis inkluderar konsekvent stil och struktur, korta och tydliga sammanfattningar, tydlig klassificering av ändringarna (buggfix, funktion, förbättring), och att referera till ärenden eller issues. Uppdatera loggen regelbundet i samband med releaser för att behålla en användbar historik.