Instruktioner för användardokumentation
Här finns beskrivet vad en användardokumentation (-handbok, -manual) bör innehålla.



Försida/mellanblad
Användardokumentationen beskriver ofta olika delsystem och/eller programdelar då är det bra att använda försidor/mellanblad, som avskiljer de olika delarna av dokumentationen. Sidan innehåller följande uppgifter:

• Dokumentnamn
• Versionsnummer och datum
• Delsystem/Program, som dokumentationen berör (även versionsnummer)
• Uppgjort av (Namn)

Innehåll

1	Allmänt
	1.1 Användare
	1.2 Kompabilitet
	1.3 Användningsområde
	1.4 Felhantering
	1.5 Termer och förkortningar
2	Installation och ibrukstagande
	2.1 Installation
	2.3 Ibrukstagande
3	Användarinstruktioner
	3.1 Standardlösningar
	3.2 Databas-, tabell- och fältbeskrivningar
	3.3 Funktion X (namn på funktionen t.ex. Uppdatering av kunder)
	3.3.1 Användargränssnittet och grundläggande logik
	3.3.2 Indata
	3.3.3 Bearbetning
	3.3.4 Avbrytningsrutiner
	3.3.5 Avslutning
	3.3.6 Utdata
	3.3.7 Felrutiner och undantag
	3.4 Funktion Y (t.ex. Uppdatering av produkter)
	3.4.1 Användargränssnitt och grundläggande logik
	3.4.2 Grundläggande logik
	3.4.3 ...o.s.v.
4	Övrigt att beakta
5	Felmeddelanden

1 Allmän beskrivning
Kort beskrivning av vad dokumentationen innehåller och en beskrivning över kapitelindelning och vad som behandlas i de olika kapitlen.

1.1 Användare
En beskrivning av dokumentationens (systemets) användare.Fråga dig till vem dokumentatoionen är riktad och beskriv utgångspunkten, d.v.s. användarens antagna datakunskap (datamognad). Det är viktigt att överväga detta innan dokumentationen skrivs, eftersom detta i hög grad påverkar nivån på dokumentationen t.ex. hur ingående grundläggande saker om själva datorvändning skall behandlas.

1.2 Kompabilitet
Beskriv kompabilitet med andra program (system) och/eller utrustning. Hur fungerar t.ex. systemet ihop med gamla versioner eller hur fungerar kopplingar till andra programprodukter.

1.3 Användningsområde
Kort beskrivning över det användningsområde som programprodukten fungerar i och ge exempel på situationer i verksamheten där programmets funktioner behövs.
Här kan det vara bra att läsa kravspecifikationen som gjordes i början av projektet. Där finns det i bästa fall beskrivet vilka problem systemet skall lösa och/eller vilka behov som systemet skall uppfylla.
Det är bra att även nämna eventuella funktioner som inte ingår i systemet, speciellt i de fall där missförstånd kan vara möjliga eller där användaren kan tänkas antaga att en viss funktion ingår.

1.4 Felhantering
Beskriv i allmänna termer hur felhanteringen fungerar och hur felmeddelanden visas för användaren. Även rutiner för hur användaren kan rapportera fel och ge förbättrningsförslag till uppenbara felsituationer. Felhanteringsrutinerna är en viktig del av underhållsrutinerna. Kontaktpersonens adress- och telefonuppgifter bör även anges här.

1.5 Termer och förkortningar
Här förklaras de termer och förkortningar som allmänt används i verksamheten och som förekommer i systemlösningen. Indelning kan göras i (1) viktiga termer i användningsområdet (finns i verksamheten) och (2) adb-tekniska termer (tillkommit vid byggandet av systemet t.ex. olika koder och logiska kopplingar).


2 Installation och ibrukstagande
Kort beskrivning av vad som gäller vid installation och ibrukstagande. Underlag för detta bölr finnas i projektplanen i det avsnitt som behandlar implementation och ibrukstagande.

2.1 Installation
Instruktioner för programvarans installation och ibrukstagande beskrivs här. Beskriv vilka uppgifter som bör redas ut innan installationen kan göras, t.ex. utrymmesbehov på hårdskivan, katalogstrukturer, utrustningsbehov, eventuella användar-id och password, användarrättigheter (r/w) (=läs-/skrivrättigheter).
I stort sett rör det sig om följande:

• Fysiska behov
• Kopiering av programvaran och säkerhetskopior
• Själva installationsproceduren
• Att göra programvaran klar för användning (Customization)

2.2 Ibrukstagande
Vad bör användaren känna till innan programvaran kan tas ibruk och finns det något speciellt som bör tas i beaktande vid användningen av programvaran.

3 Användarinstruktioner
Här beskrivs användningen av systemet funktion för funktion. Det gäller att beskriva hur systemets funktioner skall användas i verksamheten. Standardlösningar som gäller genomgående i systemet tas upp, databaser och register beskrivs, datafält och koder förklaras, olika fönsters funktioner och knappar förklaras och in- och utdata beskrivs.

3.1 Standardlösningar
Gemensamma standardlösningar beskrivs här och behöver sedan inte tas upp under respektive funktion. Det kan gälla funktionsknappar, snabbval (typ Ctrl+C), användning av musknapparna (höger (=default), vänster), utformning av menyer/undermenyer, fönster/underfönster, klick, dubbelklick, enter-knappens betydelse, avbryta utan att spara (cancel), avbryta och spara, avsluta (exit), fönsterteknik....

3.2 Databas-, tabell- och fältbeskrivningar
Här beskrivs alla tabeller och/eller databaser, som är gemensamma för systemet. Alla fält beskrivs med typ, längd, valideringskontroller, defaultvärden, kodförklaringar och exempel på inmatningsdata. Dessa kan sedan förtydligas under respektive funktion om det gäller uppgifter som är specifika för en vissa funktioner.

3.3 Funktion X
Kort beskrivning på vad som görs i denna funktione och hur den hänger ihop med hela systemet.

3.3.1 Användargränssnitt och allmän beskrivning
Här beskrivs användargränssnittet (läs: fönstet/fönstren) för denna funktion. Utgångspunkten är en detaljerad bild där det framgår vilka element (inmatningsfält, menyval, knappar o.s.v.) som användaren har till förfogande. Här beskrivs logiken i funktionen och allt vad användaren behöver känna till för att kunna använda systemet t.ex. behörighetskontroller i forma av användar-id och lösenord.
Olika typer av situationer där programmeddelanden förekommer beskrivs. Möjliga felsituationer beskrivs och hur dessa skall undvikas eller åtgärdas. Det önskade resultatet beskrivs och det som användaren bör göra för att nå dit.

3.3.2 Indata
Här beskrivs all indata, såsom blanketter och information från verksamheten som behövs för funktionen, t.ex. inköpsorder, faktura, arbetade timmar...o.dyl. Även sådan data som behövs från andra system eller från andra funktioner. Det kan finnas data som måste vara uppdaterade innan funktionen fungerar som den skall, t.ex. betalningsvillkor i faktureringsrutinen, lönearter i lönerutiner, bokföringskonton i redovisningssystem...

3.3.3 Bearbetning
Här beskrivs de bearbetningsregler som gäller för funktionen och för den data/information som matas in i de olika inmatningsfälten. Saker som tas upp och beskrivs: obligatoriska parameteruppgifter, obligatoriska (required) fält, defaultvärden, ordningsföljd i bearbetning, valideringskontroller för olika inmatningsfält.
Förutom bearbetningsregler tas även upp vad användaren kan göra eller inte göra i olika situationer och om det är möjligt att hopa till andra rutiner eller fönster.
Om det är möjligt att starta bakgrundsjobb (processer) eller uppdateringskörningar bör reglerna för dessa beskrivas.

3.3.4 Avbrytningsrutiner
Här beskrivs vilka regler som gäller för avbrytning av rutinen och om och när det är möjligt att göra det. Speciellt bör uppdateringsfunktioner förklaras. Vad händer med uppdatering av databas/register vid en eventuell avbrytning (cancel). Är det möjligt att avbryta en rutin och fortsätta senare eller inte. Om en avbrytning förorsakar funtionsstörningar bör detta omnämnas.

3.3.5 Avslutning
Här beskrivs hur funktionen avslutas på ett korrekt sätt och de situationer där avslutning är möjlig. Kommer det ett Yes/No- meddelande (bekräftning) innan rutinen kan avslutas. Vad händer ifall rutinen avslutas på ett onormalt sätt och hur skall detta behandlas. Hur vet användaren att rutinen är avslutad (meddelande)

3.3.6 Utdata
Beskrivning av den utdata som funktionen leder till, t.ex. utseende på skärmen, uppdatering av databaser eller register, inverkan på andra funktioners utförande, utskrift av rapporter.

3.3.7 Felrutiner och undantag
Möjliga felsituationer och felmeddelande som kan visas i denna funktion beskrivs. För varje typ av fel bör anges orsak till felet och nödvändig åtgärd för eliminering av felet. Här bör omnämnas om det finns kända fel eller brister i denna funktion (Det kan vara fråga om medvetna beslut som tagits i utvecklinsprojektet).


4 Övrigt att beakta
Här tas upp allmänna saker som gäller hela systemet och som inte har beskrivits tidigare. Det kan vara fråga om t.ex. systemets/programmens specialegenskaper, undantagsfall till standardregler, kända fel och brister, framtida uppdateringsplaner, framtida tilläggsfunktioner...

5 Felmeddelanden
Det kan vara bra att ha en föteckning på alla felmeddelanden som finns i programmen och hur de skall åtgärdas. Ibland kan det vara lämpligt att ge varje felmeddelanden en egen kod och sortera denna föteckning enligt felkoden för att underlätta sökning. Användaren bör för varje typ av fel få information om orsak till felet, förklaring till felet och hur felet åtgärdas och förhindras/elimineras i fortsättningen.