Třídění problémů

BeeWare pravidelně dostává hlášení o problémech od uživatelů, kteří se s nimi potýkají. Když je nahlášen nový problém, je třeba toto hlášení třídít – to znamená, že potřebujeme někoho, kdo si hlášení přečte, vezme informace poskytnuté oznamovatelem a pokusí se popsaný problém reprodukovat.

Bohužel, ačkoli zprávy o problémech jsou obvykle míněny dobře, jsou často neúplné nebo matoucí. Účelem procesu třídění je vyplnit mezery v původní zprávě. To znamená buď získat dostatek podrobností, abychom mohli potvrdit, jak lze problém reprodukovat, nebo potvrdit, že původní autor zprávy se ve své zprávě mýlil.

Třídění problému neznamená, že se od vás očekává jeho vyřešení. V závislosti na problému nemusí třídění ani zahrnovat psaní kódu. Problém můžete třídit i s velmi malými znalostmi BeeWare, protože byste měli být schopni postupovat podle kroků uvedených v hlášení a reprodukovat popsaný problém.

Přispívání k třídění problémů

Reprodukujte problém

Problém nelze vyřešit, pokud ho vůbec nemáte. Proto je reprodukce problému nezbytným předpokladem pro jeho vyřešení. V softwaru se problémy běžně označují jako „chyby“ (https://en.wikipedia.org/wiki/Software_bug) a problémy se často nazývají „hlášení o chybách“.

Někdo nahlásil chybu. Musíte ověřit, zda kroky popsané v hlášení vedou k nahlášené chybě. Můžete dosáhnout stejného výsledku, pokud provedete přesně to, co je popsáno v hlášení? Pokud ne, musíte zjistit proč.

Chyby v kódu

V ideálním případě budete mít stejné nastavení jako osoba, která chybu nahlásila, budete postupovat podle pokynů a budete schopni chybu reprodukovat tak, jak je popsáno. V mnoha případech to však nebude tak jednoduché. Mnoho hlášení chyb obsahuje pouze vágní vysvětlení a vágní sadu podmínek. Problémem je, že mnoho chyb se liší v závislosti na sadě podmínek, včetně toho, jak s nimi uživatel pracuje, různých předpokladů, operačního systému, verze operačního systému, architektury CPU nebo toho, zda je počítač uživatele starý a pomalý, nebo nový a rychlý. Čím více informací o situaci kolem chyby máme, tím lépe. Zkuste reprodukovat podmínky, které uvedl autor hlášení. Pokud se vám to nepodaří, dalším krokem může být vyžádání dalších informací od osoby, která chybu nahlásila.

Nejlepší způsob, jak reprodukovat chybu, je použít co nejmenší příklad, který stále vykazuje daný problém. Většinou uživatelé neposkytují minimální funkční příklad; pokud poskytnou jakýkoli příklad, bude přímo zkopírován z jejich „reálné“ aplikace. Vaším cílem bude zredukovat hlášení na nejjednodušší možnou formu, která problém projeví. Nejlepším případem reprodukce je co nejmenší program. Tato redukce je sama o sobě užitečná, protože určuje, v čem spočívá skutečný problém. Kdokoli může vzít minimální příklad, spustit ho a pozorovat popsanou chybu.

Chyby v dokumentaci

Chyby v dokumentaci se mohou projevovat různými způsoby. Mohou se vyskytnout problémy s formátováním, které vedou k problémům se zobrazením. Někdy se ani nejedná o chybu; osoba mohla dokumentaci špatně přečíst nebo udělala opravdovou chybu. To nutně neznamená, že s dokumentací není žádný problém. Obsah může být nejasný nebo nepřesný, což vede k záměně nebo nesprávnému výkladu. Je možné, že koncept, který by měl být projednán, není, protože není vůbec zdokumentován.

Když je nahlášena chyba týkající se dokumentace, je třeba ověřit, zda nahlášený problém skutečně stále existuje. V případě problémů s vykreslováním je třeba sestavit dokumentaci a zkontrolovat, zda se problém dá reprodukovat. Problémy s obsahem je třeba ověřit přečtením, aby se zjistilo, zda nikdo neodeslal aktualizaci.

Aktualizujte problém

Posledním krokem v procesu třídění je zdokumentování vašich zjištění prostřednictvím komentáře k danému problému.

Pokud jste schopni problém přesně reprodukovat tak, jak je popsán, stačí to uvést. Zanechte komentář, ve kterém uvedete, že jste potvrdili, že se u vás vyskytuje stejný problém, přesně tak, jak jej popsal původní autor hlášení.

Pokud jste schopni poskytnout další souvislosti, uveďte podrobnosti o těchto souvislostech. Může se jednat například o možnost reprodukovat problém na jiném operačním systému nebo s jinou verzí některého z použitých softwarů, případně o jakékoli jiné odlišnosti od původní zprávy.

Pokud v původní zprávě chyběly podrobnosti potřebné k reprodukci problému, uveďte tyto podrobnosti. Může se jednat například o údaje o operačním systému nebo verzi, které v původní zprávě nebyly uvedeny, úplnější protokoly nebo záznamy o stavu paměti, případně jasnější pokyny k přesnému postupu potřebnému k reprodukci problému. Pokud jste vyvinuli jednodušší způsob reprodukce problému (nebo původní autor zprávy neposkytl případ reprodukce), můžete uvést podrobnosti o této metodice reprodukce.

Pokud problém nelze reprodukovat, zanechte také komentář s podrobným popisem toho, co jste zkusili. Vědět, kde problém neexistuje, je téměř stejně důležité jako vědět, kde existuje, protože to pomáhá zúžit možné příčiny. Pokud máte nějaké teorie o tom, proč se vám nedaří problém reprodukovat – například pokud si myslíte, že se jedná o chybu v používání nebo že problém byl vyřešen nedávnou aktualizací operačního systému – uveďte tuto spekulaci jako součást svého komentáře.

Nakonec můžete jádrovému týmu poskytnout jakékoli doporučení, které máte. Pokud se domníváte, že původní zpráva obsahuje chybu, navrhněte, aby byla záležitost uzavřena; pokud máte teorii o příčině problému, můžete ji také navrhnout. Vaše komentáře pomohou jádrovému týmu vyřešit, jak postoupit záležitost do další fáze.