Tämä dokumentti tarjoaa yleiskatsauksen Matrix42 Core -ratkaisun dokumentaatioon. Dokumentaation rakenteeseen tutustuminen auttaa saamaan dokumentaatiosta parhaan hyödyn.

Tämä dokumentti käsittelee Matrix42 Core -ratkaisun dokumentaatiota. Myyntidokumentaatio ja muu dokumentaatio eivät kuulu tämän dokumentin laajuuteen.

Yleiskatsaus

Matrix42 Core -ratkaisun dokumentaatio julkaistaan Efecte Docsissa. Se koostuu neljästä tasosta:

1. Ratkaisun esittely
2. Prosessin yleiskatsaukset
3. Käyttötapausten kuvaukset
4. Toteutusohjeet.

Uusien asiakkaiden käyttöönotoissa (Q4 2023 alkaen) mukana olevat toteutustehtävät ja testitapaukset on linkitetty osoitteessa docs.efecte.com olevaan dokumentaatioon, kuten alla olevassa kuvassa on esitetty.

Dokumenttityypit ja sisältö

Ratkaisun esittely

Ratkaisun esittely tarjoaa yleiskuvan ratkaisusta ylätasolla. Se kuvaa ratkaisua yleisellä tasolla, mukaan lukien sen keskeiset ominaisuudet ja piirteet.

Ratkaisun esittely on suunnattu pääasiassa asiakkaille.

Prosessin yleiskatsaukset

Prosessin yleiskatsaukset tarjoavat yhteenvedon kustakin prosessista. Ne sisältävät:

• Lyhyen yhteenvedon
• Luettelon sisältyvistä käyttötapauksista
• Käyttötapauskaavion
• Prosessin vuokaavion (soveltuvin osin)
• Prosessin aikajanan (soveltuvin osin)
• Terminologian
• Edellytykset
• Tulokset
• Toimijat ja roolit
• Oletustoimituksen sisällön

Prosessin aikajana

Prosessin aikajanat tarjoavat visuaalisen yleiskatsauksen prosessista siitä hetkestä, jolloin prosessi käynnistyy, siihen hetkeen, jolloin se päättyy. Aikajanat kuvaavat myös joitakin aikaan perustuvia prosessin suorituskykymittareita, esimerkiksi vasteaikaa ja ratkaisuaikaa Incident managementin tapauksessa.

Terminologia

Terminologia-luku esittelee olennaiset termit ja niiden lyhyet määritelmät.

Edellytykset

Määrittää prosessin edellytykset.

Tulokset

Määrittää prosessin tuotokset ja tulokset.

Toimijat & roolit

Kuvaa prosessiin osallistuvat toimijat ja yhdistää toimijat teknisiin rooleihin Efecte Service Management Toolissa (ESM).

Oletustoimituksen sisältö

Kuvaa Matrix42 Core -toimituksen oletustoimituksen laajuuden.

Käyttötapausten kuvaukset

Käyttötapausten kuvaukset kuvaavat prosessiin kuuluvat käyttötapaukset. Käyttötapausten kuvaukset eivät toimi sovelluksen käyttöoppaana, sillä ne eivät sisällä yksityiskohtaisia ohjeita käyttöliittymän käyttämiseen. Seuraavat luvut kuvaavat käyttötapausdokumenttien sisällön.

Esimerkkiskenaario

Esimerkkiskenaario tarjoaa tosielämän esimerkin, jossa on kontekstitietoa käyttötapauksen kuvaamiseksi käytännönläheisesti. Esimerkkiskenaarioiden tavoitteena on auttaa lukijaa ymmärtämään käyttötapaus paremmin.

Käyttötapauskaavio

Käyttötapauskaaviot tarjoavat yleiskatsauksen toimijoista, sovelluksista ja toiminnoista (pääkäyttötapaukseen kuuluvat käyttötapaukset). Käyttötapauskaaviot on dokumentoitu UML-standardin mukaisesti. Käyttötapauskaaviot kuvaavat toimintoja ja suhteita yrittämättä kuvata prosessia tai tietovirtaa siten kuin prosessin vuokaavio tekisi.

Työnkulku

Työnkulut-luku kuvaa yhden tai useamman käyttötapaukseen liittyvän työnkulun. Sitä voidaan pitää pääprosessin aliprosessina. Käytännössä työnkulut kuvataan numeroituina vaiheluetteloina.

Tulokset

Tulokset-luku kuvaa käyttötapauksen tuotokset ja tulokset. Esimerkiksi Häiriöiden ratkaiseminen -käyttötapauksen tuloksena tiketin tila asetetaan arvoon Resolved ja ongelma on ratkaistu tai sille on tarjottu kiertotapa.

Hyödyt

Hyödyt-luku kuvaa hyödyt, joita käyttötapauksen on tarkoitus tuoda organisaatiolle.

Toteutusohjeet

Toteutusohjeet-luku sisältää linkkejä käyttötapaukseen liittyviin toteutusohjeisiin.

Dokumenttien kohdeyleisöt