Det här dokumentet ger en översikt över dokumentationen Matrix42 Core lösningen. Att bekanta sig med dokumentationsstrukturen hjälper till att få ut det mesta av dokumentationen.

Detta dokument omfattar dokumentationen Matrix42 Core lösningen. Försäljningsdokumentation och annan dokumentation omfattas inte av detta dokuments omfattning.

Översikt

Dokumentationen Matrix42 Core lösningen publiceras i Efecte-dokumentationen . Den består av fyra nivåer:

1. Lösningsintroduktion
2. Pro
3. Beskrivningar av användningsfall
4. Leveransinstruktioner.

Leveransuppgifterna och testfallen som ingår i nya kunddistributioner (från och med fjärde kvartalet 2023) är länkade till dokumentationen i docs.efecte.com , vilket visas i figuren nedan.  

Dokumenttyper och innehåll

Lösningsintroduktion

Lösningsintroduktionen ger en översikt över lösningen. Den beskriver lösningen på en övergripande nivå, inklusive dess viktigaste funktioner och egenskaper.

Lösningsintroduktionen riktar sig huvudsakligen till kunder.

Pro

Processöversikterna ger en sammanfattning av varje process. Den inkluderar:

• En kort sammanfattning
• Lista över inkluderade användningsfall
• Användningsfallsdiagram
• Pro (om tillämpligt)
• Pro tidslinje (om tillämpligt)
• Terminologi
• Förkunskapskrav
• Resultat
• Skådespelare och roller
• Standardleveransinnehållet

Pro tidslinje

Pro ger en visuell översikt över processen, från det att processen initieras till dess att den avslutas. Tidslinjerna beskriver också vissa tidsbaserade processprestandaindikatorer, till exempel svars- och lösningstid vid incidenthantering.

Terminologi

Terminologikapitlet presenterar relevanta termer och korta definitioner av dem.

Förkunskapskrav

Definierar förutsättningar för processen.

Resultat

Definierar processens resultat och utfall.

Skådespelare och roller

Beskriver de aktörer som är involverade i processen och mappar aktörerna till tekniska roller i Efecte Service Management Tool (ESM).

Standardleveransinnehåll

Beskriver omfattningen av standardleveransen för en Matrix42 Core -leverans.

Beskrivningar av användningsfall

Användningsfallsbeskrivningarna beskriver de användningsfall som hör till processen. Användningsfallsbeskrivningarna fungerar inte som en uid för applikationen eftersom de inte ger detaljerade instruktioner om hur man interagerar med användargränssnittet. Följande kapitel beskriver innehållet i användningsfallsdokumenten.

Exempelscenario

Exempelscenariot ger ett verklighetsförankrat exempel med kontextuell information för att beskriva användningsfallet på ett praktiskt sätt. Exempelscenarierna strävar efter att hjälpa läsaren att förstå användningsfallet bättre.

Användningsfallsdiagram

Användningsfallsdiagrammen ger en översikt över aktörer, applikationer och åtgärder (användningsfall inom huvudanvändningsfallet). Användningsfallsdiagrammen är dokumenterade enligt UML-standarden . Användningsfallsdiagrammen beskriver åtgärder och relationer utan att försöka beskriva processen eller dataflödet som ett processflödesschema skulle göra.

Arbetsflöde

Kapitlet om arbetsflöden beskriver ett eller flera arbetsflöden som är associerade med användningsfallet. Det kan ses som en delprocess till huvudprocessen. I praktiken beskrivs arbetsflödena som numrerade listor med steg.

Resultat

Kapitlet om resultat beskriver utdata och resultat av användningsfallet. Till exempel, som ett resultat av användningsfallet Lös incidenter, sätts ärendets status till Löst och problemet har lösts, eller så har en lösning tillhandahållits.

Fördelar

Fördelskapitlet beskriver de fördelar som användningsfallet planerar att ge organisationen.

Leveransinstruktioner

Kapitlet om leveransinstruktioner innehåller länkar till leveransinstruktioner som är relevanta för användningsfallet.

De avsedda målgrupperna för dokumenten