Jak psát hlášení o chybě: Porovnání verzí

Z ISU UHK
Přejít na: navigace, hledání
(prvotní text)
 
m (průběžné doplňování)
 
Řádek 3: Řádek 3:
 
====Obecné zásady====
 
====Obecné zásady====
  
Obecně lze říci, že čím více informací a na konkrétním případu uvedete, tím lépe se příčina problému hledá. Email typu "Studentům se nejde zapsat na termín, proč?" je pro nás informačně téměř prázdný, protože nám říká pouze to, že se zřejmě nějací studenti nedokázali zapsat na nějaký termín asi zkoušky či zápočtu, ale ál netušíme vůbec nic.  
+
Obecně lze říci, že čím více informací a na konkrétním případu uvedete, tím lépe se příčina problému hledá. Email typu "Studentům se nejde zapsat na termín, proč?" je pro nás informačně téměř prázdný, protože nám říká pouze to, že se zřejmě nějací studenti nedokázali zapsat na nějaký termín asi zkoušky či zápočtu, ale dál netušíme vůbec nic.  
  
Mnohem lepší je email typu "Studenti se přes webový portál STAGu snaží na mnou vypsaný termín zkoušky, ale portál jim zobrazuje chybové hlášení. Jde například o studenta Nováka Karla, číslo studia S18X012AB, předmět KCH/ZAKCH školní rok 2020/LS, termín čtvrtek 1.4.2021 13:30 na J6. Student si najde termín a klikne na tlačítko Přihlásit. Chybové hlášení je "ORA1458-Nelze aktualizovat záznam"
+
Mnohem lepší je email typu "Studenti se přes webový portál STAGu (Moje studium - Zápis na termíny) snaží na mnou vypsaný termín zkoušky, ale portál jim zobrazuje chybové hlášení. Jde například o studenta Nováka Karla, číslo studia S18X012AB, předmět KCH/ZAKCH školní rok 2020/LS, termín čtvrtek 1.4.2021 13:30 na J6. Student si najde termín a klikne na tlačítko Přihlásit. Chybové hlášení je "ORA1458-Nelze aktualizovat záznam". Mělo by proběhnout přihlášení studenta na termín.
  
Níže tedy uvádím typické informace, které je vhodné uvádět pro práci s portálem a pro práci s nativním klientem.
+
==== Co uvádět ====
  
====Portál====
+
* Kdo činnost provádí: do portálu se přihlašuje uživatel UHK účtem, ideální je tedy vědět login, ale postačí i číslo studia. Jméno nemusí být dostatečně jednoznačné. Do nativního klienta se přímo hlásíte určitým uživatelem = rolí.
* Kdo činnost provádí: do portálu se přihlašuje uživatel UHK účtem, ideální je tedy vědět login, ale postačí i jméno
+
* Pod jakou rolí: v nativním klientovi dáno již přihlášeným uživatelem, viz první odrážka. V portálu na naprosté většině stránek je hned nahoře sekce "Informace o uživateli a jeho rolích v IS/STAG". Na některých stránkách může osoba přihlášená určitým loginem vystupovat ve více STAGovských rolích, které může přepínat pomocí combo boxu vedle jména, je tedy dobré uvést i která role je vybrána (KAtedra VYučující atp.), zejména tehdy, pokud daný uživatel v kontextu dané stránky může např. alternovat mezi pozicí "řadového" vyučujícího a vedoucího pracoviště.
* Pod jakou rolí: na naprosté většině stránekk je hned nahoře sekce "Informace o uživateli a jeho rolích v IS/STAG". Na některých stránkách můžeosoba přihlášená určitým loginem vystupovat ve víse STAGovských rolích, které může přepínat pomocí combo boxu vedle jména, je tedy dobré uvést i která role je vybrána (KAtedra VYučující atp.), zejména tehdy, pkud daný uživatel v kontextu dané stránky může např. alternovat mezi pozicí "řadového" vyučujícího a vedoucího pracoviště
+
* na jakém místě portálu/klienta: u ortálu uvést podstránku (např. Moje výuka - Zadávání známek). V nativním klientovi stačí uvést číslo formuláře z pravého horního rohu, ideálně i s číslem verze, tedny např. AN0030 v2.17.
 +
* Jaké kroky byly provedeny před tím, než došlo k hlášenému problému - tedy zejména jakým způsobem byly nastaveny filtry/vyhledávání, co konkrétně bylo vyplněno do formuláře atp.
 +
* jaké bylo nežádoucí chování systému - zobrazila se chyba? Jaká? Neozbrazila se chyba, ale systém se zachoval jinak (nesprávně) než jste očekávali? Popište, co konkrétně se stalo, a uveďte, co jste očekávali jako správné chování (a proč, pokud je např. to chování podmíněno splněním nějakých podmínek).

Aktuální verze z 20. 10. 2021, 08:04

Tato stránka je návodem, jak napsat uživatelské podpoře STAG na UHK hlášení o chybě či problému tak, abychom vám byli schopni co nejlépe pomoci bez nutnosti korespondence ohledně informací potřebných pro určení příčin problému.

Obecné zásady

Obecně lze říci, že čím více informací a na konkrétním případu uvedete, tím lépe se příčina problému hledá. Email typu "Studentům se nejde zapsat na termín, proč?" je pro nás informačně téměř prázdný, protože nám říká pouze to, že se zřejmě nějací studenti nedokázali zapsat na nějaký termín asi zkoušky či zápočtu, ale dál netušíme vůbec nic.

Mnohem lepší je email typu "Studenti se přes webový portál STAGu (Moje studium - Zápis na termíny) snaží na mnou vypsaný termín zkoušky, ale portál jim zobrazuje chybové hlášení. Jde například o studenta Nováka Karla, číslo studia S18X012AB, předmět KCH/ZAKCH školní rok 2020/LS, termín čtvrtek 1.4.2021 13:30 na J6. Student si najde termín a klikne na tlačítko Přihlásit. Chybové hlášení je "ORA1458-Nelze aktualizovat záznam". Mělo by proběhnout přihlášení studenta na termín.

Co uvádět

  • Kdo činnost provádí: do portálu se přihlašuje uživatel UHK účtem, ideální je tedy vědět login, ale postačí i číslo studia. Jméno nemusí být dostatečně jednoznačné. Do nativního klienta se přímo hlásíte určitým uživatelem = rolí.
  • Pod jakou rolí: v nativním klientovi dáno již přihlášeným uživatelem, viz první odrážka. V portálu na naprosté většině stránek je hned nahoře sekce "Informace o uživateli a jeho rolích v IS/STAG". Na některých stránkách může osoba přihlášená určitým loginem vystupovat ve více STAGovských rolích, které může přepínat pomocí combo boxu vedle jména, je tedy dobré uvést i která role je vybrána (KAtedra VYučující atp.), zejména tehdy, pokud daný uživatel v kontextu dané stránky může např. alternovat mezi pozicí "řadového" vyučujícího a vedoucího pracoviště.
  • na jakém místě portálu/klienta: u ortálu uvést podstránku (např. Moje výuka - Zadávání známek). V nativním klientovi stačí uvést číslo formuláře z pravého horního rohu, ideálně i s číslem verze, tedny např. AN0030 v2.17.
  • Jaké kroky byly provedeny před tím, než došlo k hlášenému problému - tedy zejména jakým způsobem byly nastaveny filtry/vyhledávání, co konkrétně bylo vyplněno do formuláře atp.
  • jaké bylo nežádoucí chování systému - zobrazila se chyba? Jaká? Neozbrazila se chyba, ale systém se zachoval jinak (nesprávně) než jste očekávali? Popište, co konkrétně se stalo, a uveďte, co jste očekávali jako správné chování (a proč, pokud je např. to chování podmíněno splněním nějakých podmínek).