Ohjelmistojen testauksen testidokumentaatio (esimerkki)

by: Thomas Hamilton Thomas Hamilton
Hours Päivitetty

⚡ Älykäs yhteenveto

Testidokumentaatio määrittelee strukturoidut tuotokset, jotka on luotu ennen ohjelmistotestausta tai sen aikana. Se tukee suunnittelua, toteutusta, jäljitettävyyttä ja laadunvarmistusta dokumentoimalla tavoitteet, strategiat, testitapaukset ja tulokset. Tehokas dokumentaatio parantaa kattavuutta, läpinäkyvyyttä ja toistettavuutta eri projekteissa.

  • Keskeinen periaate: Luo muodollisen ja jäljitettävän viitekehyksen, joka yhdistää vaatimukset, skenaariot, tapaukset ja tulokset kattavan testikattavuuden varmistamiseksi.
  • Toteutuksen painopiste: Sisältää keskeiset asiakirjat – testauspolitiikan, suunnitelman, strategian, RTM:n, vikaraportit ja yhteenvetoraportit – jotka kattavat koko laadunvarmistuksen elinkaaren.
  • Integraatiokäytäntö: Osallistuu laadunvarmistukseen varhaisessa vaiheessa ja ylläpitää eläviä dokumentteja versionhallintajärjestelmien, kuten GitHubin, avulla jatkuvan tarkkuuden varmistamiseksi.
  • Standardisointisääntö: Käyttää yhtenäisiä malleja (Word, Excel tai työkaluja, kuten TestRail, JIRA) dokumentaation luomisen ja tarkistamisen tehostamiseksi.
  • Keskittämisvinkki: Tallentaa kaikki testauskohteet jaettuihin tietovarastoihin (esim. Google Drive, Confluence) yhteistyökäyttöä varten.
  • Optimointitieto: Päivittyy dynaamisesti vastaamaan kehittyviä vaatimuksia, mikä parantaa testaustehokkuutta ja sidosryhmien näkyvyyttä.
  • Arviointinäkökohta: Tasapainottaa edut – selkeyden, koulutuksen ja laadunvarmistuksen – haittoihin, kuten ajankäyttöön ja ylläpitokustannuksiin.
Lue lisää

Testidokumentaatio ohjelmistotestauksessa

Mikä on testidokumentaatio?

Testidokumentaatio on dokumentaatiota ohjelmiston testausta ennen tai sen aikana luoduista artefakteista. Se auttaa testaustiimiä arvioimaan tarvittavaa työmäärää, seuraamaan resursseja ja edistymistä sekä varmistamaan riittävän testikattavuuden. Testin tallenne ja raportit ovat täydellinen kokoelma asiakirjoja, joiden avulla voit kuvata ja dokumentoida testaussuunnittelun, testisuunnittelun, testien suorituksen ja testaustoiminnasta saatujen testitulosten.

👉 Ilmoittaudu ilmaiseen live-ohjelmistotestausprojektiin

Miksi testimuodollisuuksia tarvitaan?

Testimuodollisuus

Aloittelijan on helppo olettaa, että testaus on koodin eri osien suorittamista ad-hoc-pohjalta ja tulosten varmentamista. Mutta käytännössä testaus on hyvin muodollista toimintaa ja se dokumentoidaan yksityiskohtaisesti. Testidokumentaatio tekee testauksen suunnittelusta, tarkastelusta ja suorituksesta sekä helppoa että varmennettavaa.

Testin muodollisuusaste riippuu:

  • Testattavan sovelluksen tyyppi (AUT).
  • Organisaatiosi noudattamat standardit.
  • Kehitysprosessin kypsyys.

Testaustoiminta kestää tyypillisesti välillä 30% ja 50% ohjelmistokehityksen kokonaispanostuksesta. Dokumentaatio auttaa tunnistamaan testausprosessin parannuksia, joita voidaan soveltaa tulevissa projekteissa.

Mitä testausdokumentaation tyyppejä on olemassa?

Tässä ovat tärkeimmät testidokumentaation tyypit:

”Käytännössä nämä asiakirjat luodaan eri vaiheissa – varhaisesta suunnittelusta (testauspolitiikka, strategia) toteutukseen ja päättämiseen (vika- ja yhteenvetoraportit).”
Testausasiakirjojen tyypit Tuotetiedot
Testauskäytäntö Se on korkean tason dokumentti, joka kuvaa organisaation periaatteet, menetelmät ja kaikki tärkeät testaustavoitteet.
Testistrategia Ylemmän tason dokumentti, joka määrittelee projektissa suoritettavat testitasot (tyypit).
Testisuunnitelma Testaussuunnitelma on kattava suunnitteluasiakirja, joka sisältää testaustoimien laajuuden, lähestymistavan, resurssit, aikataulun jne.
Vaatimukset Jäljitettävyysmatriisi Tämä on dokumentti, joka yhdistää vaatimukset testitapauksiin.
Testiskenaario Testiskenaario on ohjelmistojärjestelmän osa tai tapahtuma, joka voidaan todentaa yhdellä tai useammalla testitapauksella.
Testitapaus Se on joukko syöttöarvoja, suorituksen esiehtoja, odotettuja suorituksen jälkiehtoja ja tuloksia. Se on kehitetty testiskenaariota varten.
Testitiedot Testidata on dataa, joka on olemassa ennen testin suorittamista. Sitä käytetään testitapauksen suorittamiseen.
Vikaraportti Vikaraportti on dokumentoitu raportti ohjelmistojärjestelmässä olevasta viasta, joka ei suorita odotettua toimintoaan.
Testin yhteenvetoraportti Testin yhteenvetoraportti on yleistason asiakirja, joka yhteenvetää suoritetut testaustoimet sekä testitulokset.

Mitkä ovat parhaat käytännöt testidokumentaation saavuttamiseksi?

Tässä osiossa tutustumme parhaisiin käytäntöihin, jotka auttavat testidokumentaation luomisessa, esimerkkien avulla, jotka auttavat sinua ymmärtämään sitä paremmin:

  • Ota laadunvarmistus mukaan projektin alkuvaiheessa: Ota laadunvarmistustiimi mukaan projektiin alusta alkaen, jotta testidokumentaatio kehittyy tuotesuunnittelun ja -vaatimusten rinnalla.
    Esimerkiksi: Laadunvarmistus tekee yhteistyötä sprintin suunnittelun aikana alustavien testitapausten laatimiseksi käyttäjätarinoiden perusteella.
  • Pidä asiakirjat ajan tasalla: Älä vain luo testidokumentteja ja unohda niitä – päivitä niitä aina, kun vaatimukset tai ominaisuudet muuttuvat.
    Esimerkiksi: Kun kirjautumisrajapinta (API) muuttuu, päivitä siihen liittyvät testitapaukset ja tulokset välittömästi.
  • Käytä versionhallintaa: Hallitse ja seuraa kaikkia testidokumenttien muutoksia versionhallintajärjestelmien avulla sekaannusten ja tietojen menetyksen välttämiseksi.
    Esimerkiksi: Tallenna testisuunnitelmat GitHubiin, jotta voit ylläpitää selkeää versiohistoriaa ja palautusvaihtoehtoja.
  • Selkeyden ja tarkoituksen vuoksi laadittu asiakirja: Kirjaa ylös vain se, mikä auttaa sinua ja sidosryhmiäsi ymmärtämään testauksen edistymistä ja tuotoksia.
    Esimerkiksi: Sisällytä testiyhteenvetoraportit, joissa korostetaan läpäistyjä, epäonnistuneita ja estettyjä testitapauksia johdon tarkastettavaksi.
  • Käytä vakiomalleja: Noudata yhtenäistä muotoa – kuten Excel- tai Word-malleja – helpottaaksesi dokumentaation luomista ja tarkistamista.
    Esimerkiksi: Käytä vakiomallipohjaa ”Testitapausmalli”, jossa on kentät tunnukselle, kuvaukselle, edellytyksille ja odotetuille tuloksille.
  • Keskitä asiakirjojen tallennus: Säilytä kaikki projektiin liittyvät asiakirjat yhdessä paikassa, jotta tiimin jäsenet voivat käyttää niitä tai päivittää niitä helposti.
    Esimerkiksi: Säilytä testiartefakteja jaetussa Google Drive kansio, johon koko laadunvarmistus- ja kehitystiimi voi päästä käsiksi.
  • Sisällytä riittävästi yksityiskohtia: Vältä epämääräistä tai puutteellista tietoa; yksityiskohtainen dokumentaatio parantaa ymmärrystä ja vähentää virheitä testin suorituksen aikana.
    Esimerkiksi: Kirjoita ”Tarkista kirjautuminen” sijaan ”Käyttäjän kirjautumisen tarkistaminen kelvollisilla tunnistetiedoilla ohjaa kojelautaan onnistuneesti”.

AIHEESEEN LIITTYVÄT ARTIKKELIT

Milloin sinun pitäisi luoda testidokumentaatio ohjelmistotestausta varten?

Tässä on joitakin keskeisiä kohtia, joiden perusteella sinun tulisi luoda testidokumentaatio ohjelmistotestausta varten:

  • Suunnitteluvaihe: Ennen testien suorittamisen aloittamista on määriteltävä selkeästi testausstrategia, laajuus ja tavoitteet.
  • Testin valmistelu: Testaussuunnittelun aikana aikataulujen, resurssien ja ympäristövaatimusten tehokas määrittäminen.
  • Vaatimusten analyysi: Vaatimusanalyysin jälkeen varmistaa toiminnallisten ja ei-toiminnallisten spesifikaatioiden täydellinen kattavuus.
  • Suunnittelun standardointi: Ennen testitapausten suunnittelua on standardoitava formaatit ja ylläpidettävä jäljitettävyyttä kaikissa dokumenteissa.
  • Skenaarion dokumentaatio: Testisuunnittelun aikana dokumentoidaan skenaariot, syötteet, odotetut tuotokset ja testidatan yksityiskohdat.
  • Suoritusvalmius: Ennen testien suorittamista on varmistettava testiympäristön valmius, työkalut ja dokumentaation oikeellisuus.
  • Jälkiarviointi: Testauksen jälkeen tulosten, vikojen ja opittujen läksyjen kirjaaminen prosessin parantamiseksi.

Minkä tyyppisiä malleja testidokumentaatioon tarvitaan?

Tässä on joitakin malleja, joita tarvitset ohjelmistotestauksen dokumentointiin:

Mallin nimi Työkalut
Testisuunnitelmamalli Microsoft Word, Google Docs eli Confluence yhteistyömuokkaukseen ja versionhallintaan
Testitapausmalli TestRail, Zephyr (JIRAssa), Xray tai Excel/Google Sheets jäsenneltyyn testienhallintaan
Testi skenaariomalli JIRA, TestLink tai Google Sheets korkean tason testausolosuhteiden dokumentointiin
Vaatimusten jäljitettävyysmatriisin (RTM) malli Excel, Google Sheets tai TestRail vaatimusten yhdistämiseen testitapauksiin
Vikaraporttimalli JIRA, Bugzilla tai Azure DevOps virheiden kirjaamiseen ja seurantaan
Testin yhteenvetoraporttimalli Yhtymäkohta, Google Docs tai TestRailin testitulosten kokoamiseen ja analysointiin

Testidokumentaation hyvät ja huonot puolet

Plussat

  • Testausdokumentaation luomisen tärkein syy on joko vähentää tai poistaa testaustoimintaan liittyviä epävarmuuksia. Se auttaa poistamaan epäselvyyksiä, joita usein syntyy tehtävien jaossa.
  • Dokumentointi ei tarjoa vain systemaattista lähestymistapaa ohjelmistojen testaus, mutta se toimii myös koulutusmateriaalina uusille ohjelmistotestausprosessissa.
  • Se toimii hyvänä markkinointi- ja myyntistrategiana esitellä testidokumentaatiota kypsän testausprosessin havainnollistamiseksi.
  • Testidokumentaatio auttaa sinua tarjoamaan laadukkaan tuotteen asiakkaalle tietyissä aikarajoissa.
  • In OhjelmistotuotantoTestidokumentaatio auttaa myös ohjelman konfiguroinnissa tai asetuksissa konfigurointidokumentin ja käyttöoppaiden avulla.
  • Testidokumentaatio auttaa parantamaan läpinäkyvyyttä asiakkaan kanssa.

MIINUKSET

  • Asiakirjojen kustannukset voivat ylittää sen arvon, koska se vie paljon aikaa.
  • Usein sen kirjoittavat ihmiset, jotka eivät osaa kirjoittaa hyvin tai jotka eivät tunne materiaalia.
  • Asiakkaan pyytämien muutosten seuraaminen ja vastaavien asiakirjojen päivittäminen on väsyttävää.
  • Huono dokumentaatio heijastaa suoraan tuotteen laatua, sillä asiakkaan ja organisaation välille voi syntyä väärinkäsityksiä.

Yleisiä virheitä, joita tulisi välttää testidokumentaatiossa

Tässä ovat yleisimmät virheet, joita testidokumentaatiossa tulisi välttää:

  1. Vältä epäselvien tai monitulkintaisten testitapausten kuvausten kirjoittamista.
  2. Älä jätä dokumentoimatta testien ennakkoehtoja ja riippuvuuksia.
  3. Älä koskaan unohda sisällyttää odotettuja tuloksia jokaiseen testiin.
  4. Vältä epäjohdonmukaista muotoilua eri testidokumenteissa.
  5. Älä käytä epämääräisiä tai mitattavissa olevia testaustavoitteita.
  6. Älä koskaan jätä versionhallintaa pois testidokumentaation päivityksistä.
  7. Vältä tietojen päällekkäisyyttä useissa testiartikkeleissa.
  8. Älä unohda tarkistaa dokumentaatiota oikeellisuuden ja täydellisyyden varmistamiseksi.

UKK

Kirjoita testidokumentti määrittelemällä tavoitteet, laajuuden, testitapaukset, odotetut tulokset, työkalut ja yksityiskohtaiset suoritusvaiheet selkeyden vuoksi.

Laadunvarmistuksen dokumentointi varmistaa jäljitettävyyden, johdonmukaisuuden ja vastuullisuuden ja toimii näyttönä laadunvarmistusprosesseista koko kehitystyön ajan.

Dokumentointi on elintärkeää ohjelmistotestauksessa, koska se tallentaa testien kattavuuden, tulokset ja viat sekä varmistaa toistettavuuden ja prosessien parantamisen.

Luo tehokasta testidokumentaatiota ylläpitämällä selkeyttä, versionhallintaa, yksityiskohtaisia ​​vaiheita, odotettuja tuloksia ja yhdenmukaisuutta projektin vaatimusten ja standardien kanssa.

Suuret kielimallit voivat analysoida API-spesifikaatioita, vaatimusdokumentteja ja koodinäytteitä luodakseen automaattisesti kattavia testitapauksia, testisuunnitelmia ja suoritusraportteja reaaliajassa.

Kyllä. Asianmukainen dokumentointi antaa tiimeille mahdollisuuden tunnistaa kattavuusaukot, havaita ongelmat aikaisemmin ja varmistaa, että testausprosessi on linjassa liiketoiminnan vaatimusten kanssa – kaikki nämä osaltaan parantavat ohjelmistojen laatua.

Kyllä. Testausstrategia on yleisen testausmenetelmän kuvaava yleisdokumentti, kun taas testaussuunnitelma on yksityiskohtaisempi ja koskee tiettyä projektia tai julkaisua. Molemmat täydentävät toisiaan jäsennellyssä laadunvarmistusprosessissa.

Tiivistä tämä viesti seuraavasti: