how write good bug report
Per què és bo l’informe d’errors?
Si el vostre informe d'errors és efectiu, les seves possibilitats de corregir-se són més altes. Per tant, la solució d’un error depèn de la efectivitat de la notificació. Notificar un error no és altra cosa que habilitat i explicaré com aconseguir-ho.
'El punt d'escriure un informe de problemes (informe d'errors) és que els errors es solucionin' - Per Cem Kaner. Si un provador no informa correctament d’un error, és probable que el programador rebutgi aquest error afirmant que és irreproducible.
Això pot perjudicar la moral dels provadors i, de vegades, també l'ego. (Suggereixo no mantenir cap tipus d'ego. L'ego és com 'He informat l'error correctament', 'Puc reproduir-lo', 'Per què ha rebutjat l'error?', 'No és culpa meva', etc. ,).
Què aprendreu:
- Quines són les qualitats d'un bon informe d'errors de programari?
- Informes d'errors efectius
- Com informar d'un error?
- Funcions importants de l'informe d'errors
- Alguns consells addicionals per escriure un bon informe d'errors
- Conclusió
- Lectura recomanada
Quines són les qualitats d'un bon informe d'errors de programari?
Tothom pot escriure un informe d'error. Però no tothom pot escriure un informe d’error eficaç.
Hauríeu de poder distingir entre un informe d'errors mitjà i un bon informe d'errors. Com distingir entre un informe d'errors bo i dolent? És molt senzill: apliqueu les següents característiques i tècniques per informar d’un error.
Les característiques i tècniques inclouen
# 1) Tenir un número d'error clarament especificat: Assigneu sempre un número únic a cada informe d'error. Al seu torn, això us ajudarà a identificar el registre d’errors. Si utilitzeu una eina automatitzada d’informació d’errors, aquest número únic es generarà automàticament cada vegada que informeu de l’error.
Tingueu en compte el número i una breu descripció de cada error que heu informat.
# 2) Reproduïble: Si el vostre error no es pot reproduir, mai no es solucionarà.
com iniciar una cua a Java
Heu d'esmentar clarament els passos per reproduir l'error. No assumeixi ni salti cap pas de reproducció. Un error descrit pas a pas és fàcil de reproduir i corregir.
# 3) Sigueu específics: No escriviu cap assaig sobre el problema.
Sigues específic i al punt. Intenteu resumir el problema en paraules mínimes però de manera eficaç. No combini múltiples problemes encara que semblin similars. Escriviu diferents informes per a cada problema.
Informes d'errors efectius
La notificació d’errors és un aspecte important de les proves de programari. Un informe d’error eficaç es comunica bé amb l’equip de desenvolupament i evita confusions o males comunicacions.
Hauria de ser un bon informe d’errors clar i concís sense que falti cap punt clau. Qualsevol manca de claredat condueix a malentesos i alenteix també el procés de desenvolupament. L’escriptura i l’informe de defectes és una de les àrees més importants però descuidades del cicle de vida de les proves.
Una bona escriptura és molt important per presentar un error. El punt més important que ha de tenir present un provador és no utilitzar un to de comandament a l'informe. Això trenca la moral i crea una relació laboral poc saludable. Utilitzeu un to suggeridor.
No ho assumeixi que el desenvolupador ha comès un error i, per tant, podeu utilitzar paraules dures. Abans d'informar, és igualment important comprovar si s'ha informat o no del mateix error.
Un error duplicat és una càrrega en el cicle de proves. Consulteu la llista completa d'errors coneguts. De vegades, és possible que els desenvolupadors coneguessin el problema i els ignoressin per a una futura versió. També es poden utilitzar eines com Bugzilla que busca automàticament errors duplicats. No obstant això, és millor buscar manualment qualsevol error duplicat.
La informació d’importació que ha de comunicar un informe d’errors és 'Com?' i on?' L'informe hauria de respondre clarament com es va realitzar la prova i on es va produir exactament el defecte. El lector hauria de reproduir fàcilment l’error i trobar on es troba.
Tingueu en compte que objectiu d'escriure l'informe d'error és permetre al desenvolupador visualitzar el problema. Hauria d’entendre clarament el defecte de l’informe d’error. Recordeu proporcionar tota la informació rellevant que busca el desenvolupador.
A més, tingueu en compte que es conservaria un informe d’errors per a un ús futur i que s’hauria d’escriure bé amb la informació requerida. Utilitzeu frases significatives i paraules senzilles per descriure els vostres errors. No utilitzeu afirmacions confuses que perdin el temps del revisor.
Informeu de cada error com un problema independent. En cas que hi hagi diversos problemes en un únic informe d'errors, no el podeu tancar tret que es resolguin tots els problemes.
Per tant, és millor fer-ho divideix els problemes en errors separats . Això garanteix que cada error es pugui gestionar per separat. Un informe d’errors ben escrit ajuda un desenvolupador a reproduir-lo al seu terminal. Això els ajuda a diagnosticar també el problema.
Com informar d'un error?
Utilitzeu la següent plantilla d'informe d'error:
Es tracta d’un format d’informe d’errors senzill. Pot variar segons l'eina d'informe d'errors que utilitzeu. Si escriviu manualment un informe d'errors, caldrà esmentar alguns camps específicament, com ara el número d'error, que s'hauria d'assignar manualment.
Periodista: El vostre nom i adreça de correu electrònic.
Producte: En quin producte heu trobat aquest error.
Versió: La versió del producte, si n'hi ha.
Component: Aquests són els principals sub-mòduls del producte.
Plataforma: Esmenta la plataforma de maquinari on has trobat aquest error. Les diverses plataformes com ara 'PC', 'MAC', 'HP', 'Sun', etc.
Sistema operatiu: Esmenta tots els sistemes operatius on has trobat l’error. Sistemes operatius com Windows, Linux, Unix, SunOS, Mac OS. Esmenteu les diferents versions del sistema operatiu també com Windows NT, Windows 2000, Windows XP, etc., si escau.
Prioritat: Quan s’ha de corregir un error? La prioritat generalment s’estableix des de P1 fins a P5. P1 com a 'corregiu l'error amb la màxima prioritat' i P5 com a 'Corregiu quan el temps ho permeti'.
Gravetat: Això descriu l'impacte de l'error.
Tipus de gravetat:
- Bloquejador: No es pot fer cap altra prova.
- Crític: Fallada de l'aplicació, pèrdua de dades.
- Major: Pèrdua important de funció.
- Menor: Pèrdua de funció menor.
- Trivial: Algunes millores de la IU.
- Millora: Sol·licitud d'una nova característica o alguna millora a la ja existent.
Estat: Quan inicieu la sessió en qualsevol sistema de seguiment d'errors, per defecte l'estat de l'error serà 'Nou'.
Més endavant, l’error passa per diverses etapes, com ara Fixed, Verified, Reopen, Won’t Fix, etc.
=> Clica aquí per obtenir més informació sobre el detallat Cicle de vida dels errors.
Assigna a: Si sabeu quin desenvolupador és el responsable d’aquest mòdul concret en què s’ha produït l’error, podeu especificar l’adreça de correu electrònic d’aquest desenvolupador. Si no, mantingueu-lo en blanc, ja que assignarà l'error al propietari del mòdul, si no, el gestor assignarà l'error al desenvolupador. Afegiu possiblement l’adreça electrònica del gestor a la llista de CC.
URL: L'URL de la pàgina en què s'ha produït l'error.
Resum: Un breu resum de l'error majoritàriament en 60 paraules o menys. Assegureu-vos que el resum reflecteixi quin és el problema i on es troba.
Descripció: Una descripció detallada de l’error.
Utilitzeu els camps següents per al camp de descripció:
- Reproduïu els passos: Esmenta clarament els passos per reproduir l’error.
- Resultat Esperat: Com s’ha de comportar l’aplicació en els passos esmentats anteriorment.
- Resultat real: Quin és el resultat real d’executar els passos anteriors, és a dir, el comportament dels errors.
Aquests són els passos importants de l'informe d'errors. També podeu afegir el 'Tipus d'informe' com un camp més que descriurà el tipus d'error.
Els tipus d'informes inclouen:
1) Error de codificació
2) Error de disseny
3) Nou suggeriment
4) Emissió de documentació
5) Problema de maquinari
Funcions importants de l'informe d'errors
A continuació es detallen les funcions importants de l'informe d'errors:
# 1) Número / identificador d'error
Un número d'error o un número d'identificació (com swb001) facilita molt la notificació i la referència a un error. El desenvolupador pot comprovar fàcilment si s’ha resolt o no un error concret. Fa que tot el procés de proves i proves es faci més suau i fàcil.
# 2) Títol de l’error
Un títol d'error es llegeix amb més freqüència que qualsevol altra part de l'informe d'errors. Hauria de dir-ho tot sobre el que ve a l’error.
El títol de l’error hauria de ser prou suggeridor perquè el lector el pugui entendre. Un títol d'error clar facilita la seva comprensió i el lector pot saber si l'error s'ha informat anteriorment o s'ha solucionat.
# 3) Prioritat
En funció de la gravetat de l’error, es pot establir una prioritat per a ell. Un error pot ser un bloquejador, crític, major, menor, trivial o un suggeriment. Es pot donar una prioritat d'error de P1 a P5 perquè es vegin primer els importants.
# 4) Plataforma / entorn
La configuració del sistema operatiu i del navegador és necessària per obtenir un informe d’errors clar. És la millor manera de comunicar com es pot reproduir l'error.
Sense la plataforma o l’entorn exactes, l’aplicació es pot comportar de manera diferent i és possible que l’error al final del provador no es reprodueixi al final del desenvolupador. Per tant, és millor esmentar clarament l’entorn en què s’ha detectat l’error.
# 5) Descripció
La descripció d'errors ajuda el desenvolupador a entendre l'error. Descriu el problema trobat. La mala descripció crearà confusió i perdrà també el temps dels desenvolupadors i dels provadors.
Cal comunicar-se clarament sobre l’efecte de la descripció. Sempre és útil fer servir frases completes. És una bona pràctica descriure cada problema per separat en lloc d’esmicolar-los del tot. No utilitzeu termes com 'Crec' o 'Crec'.
# 6) Passos per reproduir-se
Un bon informe d’errors hauria d’esmentar clarament els passos per reproduir-los. Els passos han d'incloure accions que causen l'error. No feu declaracions genèriques. Sigueu específics en els passos a seguir.
A continuació es dóna un bon exemple d’un procediment ben escrit
Passos:
- Selecciona el producte Abc01.
- Feu clic a Afegeix a la cistella.
- Feu clic a Elimina per eliminar el producte del carretó.
# 7) Resultat esperat i real
Una descripció de l'error està incompleta sense els resultats reals i esperats. Cal esbossar quin és el resultat de la prova i què hauria d’esperar l’usuari. El lector ha de saber quin és el resultat correcte de la prova. Esmenta clarament què va passar durant la prova i quin va ser el resultat.
# 8) Captura de pantalla
Una imatge val més que mil paraules. Feu una captura de pantalla de la instància d'error amb els subtítols adequats per ressaltar el defecte. Ressalteu els missatges d'error inesperats amb un color vermell clar. Això crida l'atenció sobre l'àrea requerida.
Alguns consells addicionals per escriure un bon informe d'errors
A continuació es detallen alguns consells addicionals per escriure un bon informe d'errors:
# 1) Informeu del problema immediatament
programa de còpia de seguretat gratuït per a Windows 7
Si trobeu algun error durant la prova, no cal esperar per escriure un informe detallat d'errors més tard. En el seu lloc, escriviu l'informe d'errors immediatament. D’aquesta manera s’assegurarà un informe d’error bo i reproduïble. Si decidiu escriure l'informe d'error més endavant, hi ha moltes possibilitats de perdre els passos importants del vostre informe.
# 2) Reproduïu l'error tres vegades abans d'escriure un informe d'errors
El vostre error hauria de ser reproduïble. Assegureu-vos que els passos siguin prou robusts per reproduir l’error sense cap mena d’ambigüitat. Si el vostre error no es pot reproduir cada vegada, encara podeu presentar un error que mencioni la naturalesa periòdica de l'error.
# 3) Proveu la mateixa ocurrència d'errors en altres mòduls similars
De vegades, el desenvolupador utilitza el mateix codi per a diferents mòduls similars. Per tant, hi ha més possibilitats que l’error d’un mòdul es produeixi també en altres mòduls similars. Fins i tot podeu provar de trobar la versió més severa de l’error que heu trobat.
# 4) Escriviu un bon resum d'errors
El resum d'errors ajudarà els desenvolupadors a analitzar ràpidament la naturalesa dels errors. Un informe de mala qualitat augmentarà innecessàriament el temps de desenvolupament i proves. Comuniqueu-vos bé amb el resum de l’informe d’errors. Tingueu en compte que el resum d’errors s’utilitza com a referència per cercar l’error a l’inventari d’errors.
# 5) Llegiu l'informe d'errors abans de prémer el botó Envia
Llegiu totes les frases, redaccions i passos que s’utilitzen a l’informe d’errors. Vegeu si alguna frase crea ambigüitat que pot conduir a una mala interpretació. Cal evitar paraules o frases enganyoses per tenir un informe d’errors clar.
# 6) No utilitzeu un llenguatge abusiu
És bo que hàgiu fet un bon treball i que hagueu trobat un error, però no utilitzeu aquest crèdit per criticar el desenvolupador ni atacar cap persona.
Conclusió
Sens dubte, el vostre informe d'errors hauria de ser un document d'alta qualitat.
Centreu-vos a escriure bons informes d’errors i dediqueu una mica de temps a aquesta tasca, ja que aquest és el principal punt de comunicació entre el provador, el desenvolupador i el gestor. Els administradors haurien de tenir consciència del seu equip que la redacció d’un bon informe d’errors és la responsabilitat principal de qualsevol provador.
El vostre esforç per escriure un bon informe d’errors no només estalviarà els recursos de l’empresa, sinó que també crearà una bona relació entre vosaltres i els desenvolupadors.
Per obtenir una millor productivitat, escriviu un millor informe d'errors.
Sou experts en escriure un informe d'errors? No dubteu a compartir els vostres pensaments a la secció de comentaris següent.
Lectura recomanada
- Exemple d’informe d’errors
- Com es pot trobar un error a l'aplicació? Consells i trucs
- Com escriure un informe d'estat setmanal de proves de programari
- Què és el cicle de vida de defectes / errors en les proves de programari? Tutorial del cicle de vida de defectes
- Com podeu resoldre tots els vostres errors sense cap etiqueta 'Error no vàlid'?
- Exemples d'informes d'errors per a aplicacions web i de productes
- Com escriure un informe de resum eficaç de la prova (Descàrrega d'informe de mostra)
- Per què la notificació d'errors és un art que tots els provadors haurien d'aprendre?