Om IT-och systemdokumentation
Vill du ha en hälsocheck av din IT-dokumentation? Klicka här för att göra vårt test.
Vi har lång erfarenhet av att dokumentera olika typer av system och IT ur olika aspekter. Vi beskriver några av de vanligaste här. Du, som många andra, kanske 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 klassiska hyllvärmare till wikis.
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 den även göra det med dokumentationsarbetet. 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.
Läs om hur vi hjälpte ett fastighetsbolag att få bättre kontroll över sina IT-system.
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.
API-dokumentation
API (Application Programming Interface) är ett digitalt gränssnitt som används för att olika system ska kunna kommunicera med varandra. API-dokumentationen beskriver vilken data som kan hämtas från respektive system och hur man gör det. Väl dokumenterade gränssnitt är viktigt och underlättar för en bra implementation mellan system, vilket leder till nöjdare kunder och bättre affärer.
Läs om hur en av våra kunder fick ökad kundnöjdhet och ökad tillväxt med hjälp av docs-as-code.