IT-dokumentation är ett samlingsnamn för beskrivningar av IT-system ur olika aspekter. Vi beskriver de vanligaste här. Du kanske, som många andra, föredrar att skapa en mix av flera av dessa. Oavsett hur du väljer kan dokumentationen lagras och tillgängliggöras på många olika sätt, allt ifrån som klassiska hyllvärmare till wiki.

Utvecklingsdokumentation

Agil utveckling blir allt vanligare men ryktet om utvecklingsdokumentationens död är trots det betydligt överdrivet. Den behövs fortfarande, men precis som agila metoder delar upp utvecklingen i delar så ska dokumentationen också göra det. En bra struktur och genomtänkt dokumentationsdesign lägger en utmärkt grund för effektiv kunskapsöverföring och enkelt framtida underhåll.

Systemdokumentation

Den här dokumentationen beskriver systemet och dess ingående applikationer och delar. Tyngdpunkten ligger normalt på funktionella beskrivningar av systemets flöden och angränsande kontaktytor. En tydlig struktur och hög sökbarhet för snabb access är viktigt vid valet av format och lösning.

Förvaltningsdokumentation

Denna dokumentation är fönstret mot verksamheten i organisationen. Därför måste den vara tydlig och pedagogisk. Här beskrivs hur ändringar, incidenter och liknande ska hanteras. ITIL är en ledande metod för det och ger omfattande stöd för den dokumentation som ska tas fram.

Driftdokumentation

Här beskrivs hur systemet driftas, vad som körs vid olika tidpunkter och med vilken periodicitet. Här hittar du installationsinstruktioner, rutiner för uppdateringar, instruktioner för akuta felavhjälpningar och allt annat som behövs för att hålla systemen rullande. En tydlig struktur, hög sökbarhet för snabb access och portabel information är viktigt vid valet av format och lösning.

Referenscase

Vi är specialister på dokumentation