Användarmanualer

Innehåll och struktur

Här är ett exempel på struktur och innehållsförteckning för en manual till en maskin.

Användarmanualer ska beskriva allt från design, installation och säkerhet till förberedelser, start, normal drift, funktioner och inställningar, programvara, automatiska och manuella funktioner, normalt stopp, nödstopp, rengöring, felsökning, service och underhåll m.m.

Ordningen bör följa användarens behov beroende på var i processen den befinner sig. Användaren ska inte behöva bläddra och leta på olika ställen i manualen efter punkter som borde höra ihop.

Så långt det är möjligt och logiskt kan liknande funktioner med fördel slås ihop till ett gemensamt avsnitt med underavsnitt. Det förenklar översikten när användaren ögnar igenom innehållsförteckningen.

Innehållsförteckning sidan 1
Innehållsförteckning sidan 2
Innehållsförteckning sidan 3