Bug reporting

Aneb jak nahlásit bug tak, aby byl vyřešen co možná nejdříve

Narazili jste už někdy na něco, co nefungovalo tak, jak byste čekali nebo se pokazilo něco, co dříve fungovalo? Není třeba nad takovou situací zoufat, ač může být nepříjemná, stačí, když nám dáte vědět a my se na to podíváme.

Abychom ale byli schopni vám pomoci co možná nejlépe, potřebujeme znát váš problém a právě k tomu, abychom neztráceli čas tunou korespondence slouží tento článek zaměřený právě na to, co přesně potřebujeme vědět, abychom váš problém byli schopni analyzovat a přijít s řešením v co možná nejkratším čase.


První pomoc při problémech

Všichni určitě známe ten nepříjemný pocit, když se něco přestane chovat tak, jak jsme doposud byli zvyklí. Nejdůležitější je v takových situacích zachovat chladnou hlavu a nejdříve se zamyslet nad následujícími body:

Pokud ani jedna z výše zmíněných otázek nepovede k vyřešení neváhejte se na nás obrátit.


Základní zásady bug reportingu


Krátký a výstižný název

Díky názvu si rychle zvládneme udělat představu o kontextu, aniž bychom se museli více ponořit do dalších detailů. Je možné že obdobný problém byl již nahlášen a je řešen a právě krátký, ale vypovídající název může celý proces značně zrychlit.

    • "Přiřazení QR kódu" - takový název nám ihned dá kontext čeho se reportovaný problém týká, není zde třeba více specifikovat, od toho máme další kroky.
Specifikace prostředí a verze

Specifikací prostředí se v našem kontextu myslí verze Odoo, kterou používáte. Máte Odoo 16, Odoo 17 nebo jste zarytý klasik s Odoo 14? Tato informace je pro nás klíčová, jelikož ne vše je kompatibilní se všemi verzemi Odoo, technologie stále utíkají dopředu a pro starší verze musíme zvolit trochu jiný přístup než u verzí nových.

Do specifikace prostředí patří i edice vašeho Odoo, tedy zda využíváte Community nebo Enterprise. Rozdíl mezi těmito edicemi je primárně v jejich rozsahu a množství základních Odoo aplikací, pro jednu edici může být oprava chybného chování jednodušší než u druhé a naopak.

Budeme-li mluvit o verzi, pak je zde myšlena poslední nainstalovaná verze, kterou využíváte, zvláště důležitá je tato informace využíváte-li některé z našich modulů, jako jsou například lokalizační moduly účetnictví. K tomu abyste verzi zjistili nemusíte složitě otevírat repozitáře ani nic podobného a můžete ji zjistit přímo v Odoo:

Zvolit modul "aplikace"

Zvolit detail aplikace účetnictví a informace o modulu

Nalezení hodnoty "nejnovější verze"

Shrnutí problému

Stačí ve dvou až třech větách zjednodušeně opsat o co se jedná. V podstatě je shrnutí upřesnění toho, co se do názvu nevešlo, abychom měli ještě o něco bližší představu o problému se kterým se potýkáte.

    • "Při vytvoření faktury z obchodní nabídky se nepřiřazuje QR tak, jak je popsáno v dokumentaci" - díky takto stručnému shrnutí již známe podstatu problému, což nám umožní zhodnotit závažnost a náročnost opravy (v tomto případě i dosavadní způsob řešení problému, což by bylo manuální přiřazení QR)
Postup pro replikace problému

Podklady pro replikaci jsou jednou z nejpodstatnějších informací, které nám můžete poskytnout. Problém ,který nejsme schopni replikovat u nás se velmi špatně řeší a pokud se nám nepodaří jej replikovat, je možné že ani nebudeme schopni řešení problému nalézt, zvláště jedná-li se o složitější funkční záležitosti, kde jsou návaznosti úkonů pro řešení mnohdy důležité.

Postup je nejlepší rozmělnit do více kroků a tady se nemusíte bát odrážek nebo dovysvětlení kontextu v rámci kterého pracujete. Nejdůležitější zde je jak jste postupovali, na jakém zobrazení jste byli, upravili jste něco, na co jste klikli, co se zobrazilo, mělo/nemělo se něco zobrazit,... K tématu replikace se pojí i následující zásada, proto se nebojte nás namísto sáhodlouhého popisu odkázat na obrázek nebo přílohu.

    • "Vytvořím obchodní nabídku pro našeho českého zákazníka. Měna faktury je v českých korunách a má být zaplacena na náš standardní český účet." - v kontextu QR kódu je vždy důležitá měna a zda je nastaven správný účet, proto vždy nejprve doporučujeme zkontrolovat zda vše odpovídá tak, jak je uvedeno v dokumentaci/specifikaci vašeho modulu nebo úpravy na míru
    • "Po vytvoření nabídku potvrdím kliknutím na tlačítko "Potvrdit" a následně kliknu na "Vytvořit fakturu". Zvolím možnost "Předplatba (procentem)", doplním procentuální výši a kliknu na tlačítko pro vytvoření návrhu faktury. Po zkontrolování fakturu potvrdím a přes ozubené kolečko si vygeneruju PDF faktury, kde chybí české QR." - Takový popis je samozřejmě dostačující, nicméně to není vše co potřebujeme vědět a je třeba abyste ještě pár věcí zkontrolovali, zda je vše v pořádku (a k tomu napomůže samozřejmě naše dokumentace).
    • "Ujistili jsme se, že v systému je povolené QR a zkontrolovali že náš účet je ve správném formátu dle dokumentace. Dále jsme zkontrolovali záložku "Další informace" na dané faktuře a v poli "QR kód platby" chyběla hodnota, která dle dokumentace měla být doplněna, jak ukazuje screenshot." - díky části jako je tato víme, že jste provedli základní kontrolu a díky screenshotu, který si ukážeme v dalším kroku, si dovedeme udělat ještě bližší představu problému se kterým se potýkáme.
Přílohy aneb obrázek řekne více než tisíc slov

Je tomu skutečně tak, namísto sáhodlouhé slohovky a snahy zjistit o jaký typ zobrazení se jedná je printscreen, případně PDF chybného dokumentu to nejjednodušší co můžete udělat. V Odoo jde spoustu věcí, řešit vícero způsoby a je možné, že se sem tam na nějaký zapomene, pořád jsme přeci jen lidé.

Zároveň se nebojte na obrázku kroužků, šipek a dalších ukazatelů, krátkých popisků a dalších které nás nasměrují k jádru problému.

Záložka "další informace" na zobrazení zákaznické faktury

    • Z jednoduchého screenshotu dokážeme mnohdy vyčíst více než se může zdát. Na tomto případě jsme schopni odhadnout zda vše odpovídá popsanému postupu. Na tomto příkladu si velice rychle ověříme zda je správná měna a formát účtu (Odoo sice zobrazuje IBAN, ale v rámci našich účetních modulů jsou implementovány přepočty na české číslo účtu, které je využíváno).
Závažnost problému

Jak posoudit závažnost problému je poněkud komplexní téma, nicméně tou nejdůležitější informací je, zda vás daný problém nějakým způsobem blokuje v práci takovým způsobem, že nejste svou práci schopni plnohodnotně vykonávat. V takovém případě se v našem kontextu budeme bavit o blokačním bugu. 

Pokud se však jedná o nesrovnalost, kterou jste na pár kliknutí schopni sami opravit, ač to dříve fungovalo jinak nebo samo, pak se jedná o prostý bug.

Toto jednoduché rozdělení nám dá představu o tom, které problémy mají přednost a které nejsou tolik kritické. Blokační bugy jsou analyzovány a řešeny přednostně, právě z důvodů, že mohou silně narušovat chod vašeho podnikání. Samozřejmě není třeba se bát i prosté bugy bereme vážně, abychom vám co nejvíce zpříjemnili a zjednodušili vaši každodenní práci.

Nezbývá než čekat na odpověď

Poslední krok bývá ten nejvíc nervy drásající, nicméně se vždy snažíme nejpozději do tří pracovních dnů dát vědět s alespoň nějakými bližšími informacemi k vámi hlášenému problému a případně se doptáme na doplňující informace, pokud narazíme při prvotní analýze na problém.

Samozřejmě se vždy snažíme dát vědět co nejdříve, ale také chceme respektovat váš čas a eliminovat nadbytečnou korespondenci, která může být mnohdy daleko více frustrující než užitečná. Na nahlášené problémy se vždy podíváme a i v případě, že již byl vyřešen nebo je možno jej vyřešit například v nastavení, rádi vás nasměrujeme tím správným směrem.


Jak reportovat

Možností je zde více, nicméně některé jsou více a některé méně preferované k čemuž si samozřejmě řekneme více u jednotlivých způsobů.


Bug reporting
ORIGAMIS s.r.o., Lucie Kubáková 6. května 2024
Newsletter lokalizace

Zůstaňte v obraze!