Näin kirjoitat hyvän tukipyynnön1
Hyvin kirjoitettu tukipyyntö auttaa meitä ratkaisemaan ongelmasi nopeammin. Alla on luettelo hyvistä käytännöistä.
Määrittele ympäristösi
Millä järjestelmällä ajat? Oletko sinä tai kollegasi kääntänyt koodin? Mitkä moduulit oli ladattu? Jos käytät muita kuin oletusmoduuleja tai esimerkiksi Conda-ympäristöjä etkä kerro niistä meille, aikaa kuluu hukkaan, kun yritämme selvittää ongelmaasi eri ympäristössä.
Sisällytä mukaan varsinaiset komennot ja virheilmoitukset
Käsittelemme tätä tarkemmin alla, mutta tämä on niin tärkeää, että se pitää mainita myös heti alussa: sisällytä mukaan ajamasi varsinaiset komennot ja varsinaiset virheilmoitukset (myös Slurmin virhe- ja tulostetiedot). Kopioi ja liitä ne.
Anna kuvaava otsikko
Viestin otsikon tulisi olla kuvaava. "Problem on Mahti" ei ole hyvä otsikko, koska se voisi sopia moniin saamiimme tukiviesteihin. Tukihenkilöstö toimii tiiminä. Otsikko on ensimmäinen asia, jonka näemme, ja hyvä otsikko nopeuttaa asian ohjautumista oikealle asiantuntijalle.
Ole täsmällinen
Älä missään tapauksessa sano vain, että ”X ei toiminut”. Kerro tarkat ajamasi komennot, ympäristö (katso yllä) ja tulosteiden virheilmoitukset. Varsinaiset virheilmoitukset ovat erittäin tärkeitä – sisällytä koko tuloste, sillä se on helppo kopioida ja liittää.
Mitä paremmin kuvaat ongelman, sitä vähemmän meidän tarvitsee arvailla ja kysellä lisätietoja. Tee ongelmasta toistettavissa oleva. Katso myös seuraava kohta.
Kerro, mitä dokumentaatiota olet jo lukenut
Jos pyydät neuvoja esimerkiksi tietyn ohjelmistopaketin käyttöön, kerro yksityiskohtaisesti, mitä dokumentaatiota olet jo lukenut ja miksi se ei ole vielä täysin vastannut kysymykseesi. Näin voimme vastata juuri sinun kysymykseesi sen sijaan, että vain ohjaisimme sinut olemassa olevaan dokumentaatioon.
Lähetä pyyntösi ServiceDeskiin
Lähetä pyynnöt aina CSC Service Deskiin äläkä suoraan henkilökunnan jäsenille. ServiceDeskissä niitä seurataan, ne ovat paremmin näkyvillä ja oikea asiantuntija ottaa ne käsittelyyn. Osa henkilökunnasta käsittelee tukipyyntöjä vain osa-aikaisesti, ja olemme myös joskus lomalla.
Kerro myös, mikä toimi
Saamme melko usein pyyntöjä tyyppiä "En saa X:ää toimimaan kahdella noodilla". Pyynnössä ei silloin kerrota, toimiko se yhdellä noodilla tai yhdellä ytimellä tai oliko kyseessä aivan ensimmäinen yritys eikä se ollut koskaan toiminut. Ehkä ongelma ei edes liity yhteen tai kahteen noodiin. Jotta voimme rajata ongelmaa paremmin ja välttää aikaa vievän edestakaisen sähköpostittelun, kerro myös, mikä on tähän mennessä oikeasti toiminut. Kerro, miten olet yrittänyt rajata ongelmaa. Tämä vaatii sinulta hieman vaivaa, mutta auttaa meitä ratkaisemaan ongelmasi nopeammin.
Tunnistaudu
Anna CSC-käyttäjätunnuksesi ja ammatillinen organisaatiosi (jos käytät muuta kuin työsähköpostiosoitetta, kuten gmailia).
Uusi ongelma, uusi sähköposti
Älä lähetä tukipyyntöjä vastaamalla vanhoihin tiketteihin, jotka todennäköisesti koskevat eri asioita. Jokainen asia saa oman numeronsa, ja tämä on se numero, jonka näet otsikkorivillä.
XY-ongelma
Tämä on klassinen ongelma. Lue lisää XY-ongelmasta täältä. Usein tiedämme ratkaisun, mutta joskus emme tiedä ongelmaa.
Lyhyesti sanottuna (lainaus edellä mainitulta sivustolta):
- Käyttäjä haluaa tehdä X:n.
- Käyttäjä ei tiedä, miten X tehdään, mutta ajattelee, että sen voi tehdä Y:n avulla.
- Käyttäjä ei tiedä myöskään, miten Y tehdään.
- Käyttäjä pyytää apua Y:hyn.
- Muut yrittävät auttaa käyttäjää Y:n kanssa, mutta ovat hämmentyneitä, koska Y vaikuttaa oudolta ongelmalta ratkaistavaksi.
- Lopulta ongelma ratkaistaan tekemällä X ilman Y:tä.
Välttääksesi XY-ongelman, jos kamppailet Y:n kanssa mutta todellisuudessa tavoitteesi on X, kerro meille myös X:stä. Kerro, mitä todella haluat saavuttaa. Y:n ratkaiseminen voi viedä paljon aikaa.
Luo esimerkki, joka toistaa ongelman
Luo esimerkki, jonka voimme mieluiten vain kopioida, liittää ja ajaa ja joka osoittaa ongelman. Muuten tukitiimiltä kuluu paljon aikaa syötetiedostojen kirjoittamiseen ja skriptien ajamiseen mahdollisesti puutteellisen kuvauksesi perusteella. Katso myös seuraava kohta. Anna tämä esimerkki meidän käyttöömme. Emme etsi emmekä lue lukuoikeuksin suojattuja tiedostoja ilman lupaasi (ja vain hyvin harva edes voi tehdä niin).
Tee esimerkistä mahdollisimman pieni ja nopeasti ajettava
Ajat laskentaa, joka kaatuu viikon ajon jälkeen. Saatat houkutella kirjoittaa tuesta heti tällä esimerkillä, mutta se ei ole hyvä ajatus. Ennen kuin lähetät tukipyynnön tällä esimerkillä, yritä ensin pienentää sitä. Mahdollisesti ja todennäköisesti kaatuminen voidaan toistaa paljon pienemmällä esimerkillä (pienempi järjestelmän koko, hilakoko tai kantajoukko). On paljon helpompaa aikatauluttaa ja selvittää ongelma, joka kaatuu muutaman sekunnin jälkeen, verrattuna ajoon, joka kaatuu tuntien jälkeen. Tämä vaatii sinulta toki hieman vaivaa, mutta auttaa meitä ratkaisemaan ongelmasi nopeammin. Usein ongelmaa rajattaessa ongelma ja ratkaisu alkavat hahmottua jo ennen itse tukipyynnön kirjoittamista.
Jos et voi luoda esimerkkiä, selitä mitä olet tehnyt
Selitä vaiheet ja komennot, jotka olet antanut ennen ongelmaa, sekä kaikki syntyneet tulosteet ja virheet. Jos datan määrä on suuri (yli 1 Mt), voit käyttää FUNET FileSenderia tai a-flipiä tiedostojen toimittamiseen. Ole täsmällinen, katso yllä.