Pitääkö sanomarajapintojen dokumentoinnin olla erillinen työvaihe?

Paneuduimme edellisissä blogeissamme testaukseen liittyviin sudenkuoppiin. Miten käy, kun soppaan lisätään dokumentointi? Sanomarajapintojen dokumentointi ja sanoma-aineistojen teknisten tarkistusten toteutus ovat perinteisesti kaksi erillistä työvaihetta. Tästä voi syntyä useita ongelmia. Mitkä ongelmat toistuvat lähes jokaisessa yrityksessä ja miten ongelmaa kannattaa lähteä ratkaisemaan?

Kahden eri työvaiheen yleisimmät ongelmat:

  • Jos vaatimusten dokumentointi ja vastaavien teknisten tarkistusten toteutus ovat kaksi erillistä toimenpidettä, syntyy turhaa toisteista työtä.
  • Työvaiheista vastaavat usein eri henkilöt. Tästä seuraa helposti inhimillisiä virheitä, joiden selvittämiseen kuluu aikaa ja resursseja. Ongelmia aiheuttaa etenkin se, ettei dokumentoija useinkaan ymmärrä kirjaamiensa vaatimusten monitulkintaisuutta.
  • Versiopäivitykset ovat ongelmallisia, jos dokumentoinnista ja teknisten tarkistusten ylläpidosta vastaavat eri henkilöt. Tällöin pienetkin muutokset edellyttävät koordinointia, jolla on työllistävä ja prosessia hidastava vaikutus – virheherkkyydestä puhumattakaan.
  • Kun dokumentaatio on irrallinen tuotos, ei sen laatua voida varmistaa. Jos dokumentaation laatuun ei voida luottaa, voidaan todelliset vaatimukset usein todeta vain järjestelmäkoodia tarkastelemalla. Tämä kaikki on omiaan kasvattamaan riskejä ja kustannuksia vähäistenkin henkilövaihdosten yhteydessä.

Automaatiosta apua ongelmaan

Miten määrittelyvaiheessa ja versiopäivitysten yhteydessä sitten vältytään tulkintaeroilta ja toisteiselta työltä? Dokumentaation ja teknisten tarkistusten tulee olla täsmälleen saman asian ilmentymiä. Tämä saavutetaan vain tuottamalla ne ohjelmallisesti samoista määrityksistä.

Määritysten yksiselitteisyys varmistetaan edellyttämällä, että vaatimukset tulee kuvata täsmällisinä sääntöinä, joista pätevä työkalu pystyy automaattisesti tuottamaan selkokielisen dokumentaation ja tekniset tarkistukset. Vain tällainen toimintatapa takaa, että esitetyt vaatimukset ovat myös koneellisesti tarkistettavissa. Näin toimimalla syntyy myös dokumentaatio, jonka ajantasaisuuteen voidaan aina luottaa.

Oikeanlaisella työkalulla sanoma-aineistojen testauksen ja sanomarajapintojen dokumentoinnin prosessia voidaan virtaviivaistaa. Olettehan yhteydessä, jos kaipaatte apua toimintatapojenne kehittämiseen. Lisätietoja www-sivuiltamme: https://www.netum.fi/tuotteet/truugo/ ja www.truugo.com