software testing documentation guide
A la meva carrera de proves de programari, mai no vaig escoltar a la gent parlar molt de documentació sobre proves de programari. L'opinió general sobre la documentació de proves és que qualsevol persona que tingui temps lliure pot fer la documentació com un cas de prova, un pla de prova, un informe d'estat, un informe d'errors, una proposta de projecte, etc.
Fins i tot no vaig insistir més en la documentació, però puc dir que és el meu costum posar totes les dades en blanc i negre i actualitzar-ne d’altres també.
Què aprendreu:
- La meva experiència
- Documentació de la prova: què és això?
- 10 consells per ajudar-vos a assolir l'objectiu de documentació de prova
- Documents importants de proves de programari
- Conclusió
- Lectura recomanada
La meva experiència
Només vull compartir la meva experiència amb vosaltres:
Havíem lliurat un projecte (amb un problema desconegut) a un dels nostres clients (client enutjat). I van trobar el problema al costat del client, que era una situació molt dolenta per a nosaltres i, com de costum, tota la culpa era de QA.
El problema es referia a la compatibilitat d’un lloc web. Quan em va venir a la meva opinió, tenia proves que no rebia cap document de requisit que afirma que he de comprovar també la compatibilitat del lloc web. Gràcies a Déu, estava segur.
Aquesta va ser la lliçó per a mi, em vaig adonar de la importància de la documentació i, a partir d’aquest dia, vaig començar a treballar en documents i vaig crear documents de prova com ara Pla de proves, Casos de proves, Llista de comprovació de proves de seny, Informe d’errors i molts altres.
'La tinta és millor que la millor memòria' - proverbi xinès
Documentació de la prova: què és això?
Tots llegim diversos articles sobre tecnologies i mètodes de prova, però quants de nosaltres hem vist articles sobre documentació? Sens dubte, n’hi ha pocs, és que els documents no són importants? No, però és perquè encara no ens hem adonat de la importància dels documents.
Però, si observem, el fet és que, els projectes que tenen tots els documents tenen un alt nivell de maduresa.
La majoria d’empreses no donen ni una mica d’importància a la documentació, tant com donen al procés de desenvolupament de programari. Si cerquem al web, podem trobar diverses plantilles sobre com crear diversos tipus de documents. Però quants d’ells són realment utilitzats per organitzacions o persones?
El fet és que una documentació acurada pot estalviar temps, esforços i diners a l’organització.
Tot i que es busca qualsevol tipus de certificació, per què s’estressa la documentació, és només perquè mostra la importància del client i dels processos per a l’individu i l’organització. A no ser que pugueu produir un document que sigui còmode per a l’usuari per molt bo que sigui el vostre producte, ningú l’acceptarà.
És la meva experiència, tenim un producte que té una funcionalitat una mica confusa.
Quan vaig començar a treballar-hi, vaig demanar alguns documents d’ajuda al gestor i vaig rebre la resposta: “No, no tenim cap document”. Vaig fer un problema perquè, com a QA que sabia, ningú no pot entendre com fer-ho. utilitzar el producte sense documents ni formació. I si l'usuari no està satisfet, com guanyarem diners amb aquest producte?
'La manca de documentació s'està convertint en un problema per a l'acceptació' - Wietse Venema
Fins i tot el mateix s’aplica als manuals de l’usuari. Prenem un exemple de Microsoft: llancen tots els productes amb els documents adequats, fins i tot per a l'Office 2007 disposem d'aquests documents, que són molt explicatius i fàcils d'entendre per a qualsevol usuari. Aquest és un dels motius pels quals tots els seus productes tenen èxit.
A les empreses petites, sempre escoltàvem 'rebutjos de projectes en fase de proposta o d'inici', ja que la documentació de la proposta no té un llenguatge concís i expressiu i mostri la capacitat de l'organització.
No és que les petites empreses no puguin oferir projectes de bona qualitat, sinó la seva incapacitat per expressar la seva capacitat. (Jo també treballo amb una petita organització de 80 empleats, i ho he sentit moltes vegades)
Personalment, crec que la qualitat és l’únic departament que ho pot fer possible. Som l'únic departament que pot discutir sobre això i pot proporcionar un futur reeixit a les nostres organitzacions.
Organitzem tots els debats en pocs punts en perspectiva de qualitat:
- Aclarir objectius i mètodes de qualitat
- Assegureu la claredat sobre les tasques i la coherència del rendiment
- Assegurar la coordinació interna en el treball del client
- Proporcionar comentaris sobre accions preventives
- Proporciona comentaris sobre el teu cicle de planificació
- Creeu proves objectives del rendiment del vostre sistema de gestió de la qualitat
10 consells per ajudar-vos a assolir l'objectiu de documentació de prova
Com esmentava a la meva publicació anterior, en general, la comprensió sobre la documentació de proves de programari és 'Només la pot fer la persona que tingui temps lliure'. Hem de canviar aquesta mentalitat i només nosaltres podem aprofitar el poder documental dels nostres projectes.
preguntes d'entrevistes de proves de programari per a persones experimentades
No és que no sabem fer bé la documentació. Simplement no creiem que sigui important.
Tothom ha de tenir plantilles estàndard per a tot tipus de documentació, des de l'estratègia de prova, el pla de proves, els casos de prova i les dades de prova fins a l'informe d'error.
Es tracta només de seguir algunes normes (CMMI, ISO, etc.), però quan es tracta de la implementació real, quants d'aquests documents realment utilitzem? Només hem de sincronitzar el nostre procés de qualitat amb els estàndards de documentació i un altre procés d’una organització.
El més senzill de seguir tota mena de documentació consisteix a implicar una persona en el projecte des de la fase inicial que entengui la dinàmica, el domini, l’objectiu i la tecnologia del projecte. I qui més que una persona de control de qualitat per a això (per descomptat, hi ha redactors tècnics presents per fer-ho, però tenint en compte un escenari general de petites empreses on no hi ha redactors tècnics).
en funció principal referència indefinida a
Per assolir aquest objectiu de proves i documentació, crec que ens hem de centrar en alguns punts.
Aquests són els 10 consells principals per ajudar-vos a assolir l'objectiu de documentació de la prova:
# 1) El control de qualitat hauria d’implicar-se en la primera fase del projecte perquè el control de qualitat i la documentació funcionessin de la mà.
# 2) El procés definit per QA hauria de ser seguit per persones tècniques, cosa que ajuda a eliminar la majoria dels defectes en una fase inicial.
# 3) Només creant i mantenint Plantilles de proves de programari no n’hi ha prou, obligar la gent a utilitzar-les.
# 4) No només creeu i deixeu el document, actualitzeu-lo quan sigui necessari.
# 5) El requisit de canvi és una fase important del projecte. No oblideu afegir-los a la llista.
# 6) Utilitzeu el control de versions per a tot. Això us ajudarà a gestionar i fer un seguiment dels vostres documents fàcilment.
# 7) Feu més fàcil el procés de remediació de defectes documentant tots els defectes. Assegureu-vos d'incloure una descripció clara del defecte, reproduïu els passos, l'àrea afectada i detalls sobre l'autor mentre documenteu qualsevol defecte.
# 8) Proveu de documentar el que és necessari per entendre el vostre treball i el que haureu de produir als vostres grups d'interès sempre que ho necessiteu.
# 9) Utilitzeu la plantilla estàndard per obtenir documentació. Igual que qualsevol plantilla de full Excel o plantilla de fitxer doc, s’adhereixen a totes les necessitats del vostre document.
# 10) Compartiu tots els documents relacionats amb el projecte en una única ubicació, accessible per a tots els membres de l’equip com a referència per actualitzar-los sempre que sigui necessari.
No dic que aplicant passos obtindreu resultats sobtats. Sé que aquest canvi no es produirà en un o dos dies, però almenys podem començar perquè aquests canvis comencin a produir-se lentament.
Al cap i a la fi “la documentació necessita documentació”. No és així?
Hi ha centenars de documents utilitzats en el desenvolupament de programari i el cicle de vida de les proves.
Documents importants de proves de programari
Aquí enumero alguns documents importants de proves de programari que hem d’utilitzar / mantenir regularment:
1) Pla de proves
2) Disseny de proves i Especificació de casos de prova
3) Prova d’estratègia
4) Informes de resum de proves
5) Informe d'estat setmanal
6) Documents d’usuari / Manuals
7) Informe d’acceptació de l’usuari
8) Avaluació de Riscos
9) Registre de proves
10) Informes d'errors
11) Dades de prova
12) Anàlisi de proves
A més, els provadors de programari han de referir-se regularment als documents següents:
1) Especificacions de requisits de programari
2) Documents funcionals
Conclusió
Els documents de prova de programari sempre tenen un paper important en la fase de desenvolupament / prova de projectes. Per tant, mantingueu sempre documentades les coses sempre que sigui possible. No confieu en la comunicació verbal. Estigueu sempre al costat segur.
La documentació no només us estalviarà, sinó que també ajudarà l’organització a llarg termini a estalviar milers de dòlars en formació i, sobretot, en la solució de problemes causats per la manca de documents de desenvolupament i proves.
No us documenteu només per evitar que us assenyalin amb els dits, però l’hàbit de la documentació sens dubte aportarà un enfocament sistemàtic al procés de proves, deixant enrere les proves ad hoc.
Sobre l'autor: Aquest article està escrit per un membre de l'equip de STH Tejaswini. Treballa com a gerent de control de qualitat en una organització.
Quins altres documents manteniu a les vostres activitats diàries de proves?
Lectura recomanada
- Com escriure un informe d'estat setmanal de proves de programari
- Les millors eines de prova de programari 2021 (Eines d'automatització de proves de control de qualitat)
- Prova de programari Treball d'assistent de control de qualitat
- Curs de proves de programari: a quin institut de proves de programari m'he d'afegir?
- Selecció de proves de programari com a carrera professional
- Prova de programari Treball freelance d'escriptor de contingut tècnic
- Els millors serveis de proves de programari de control de qualitat de SoftwareTestingHelp
- Tipus de proves de programari: diferents tipus de proves amb detalls