Selkeytämme dokumentaatiomme julkaisua ja nimeämistapaa

Positiivinen luottotietorekisteri on ollut toiminnassa nyt noin 2,5 vuotta, ja yhtenä kehittämiskohteenamme olemme havainneet ohjelmistokehittäjille suunnatun dokumentaation julkaisun selkeyttämisen. Jatkossa pyrimme yhtenäisempään ja selkeämpään dokumentaation nimeämiseen ja julkaisuun. 

Tähän saakka etenkin uusien ja päivitettyjen muutosten julkaisu verkkosivujemme dokumentaatio-osion Tulossa olevat muutokset -sivulle on voinut aiheuttaa epäselvyyksiä. Kun dokumentteja on päivitetty, olemme lisänneet dokumentin perään kyseisen päivityspäivämäärän ja dokumentin nimi on säilynyt ennallaan.

Miten tulkitsen tulossa olevien muutosten dokumentaatiota?

Tulossa olevat muutokset -sivulla julkaisemme etukäteen tarvittavan teknisen dokumentaation, jos rajapintojemme nykyistä toimintaa ollaan muuttamassa jollain tapaa. Lähtökohtaisesti pyrimme julkaisemaan tulossa olevat muutokset nipuissa, mutta toisinaan on tarve täydentää jo julkaistua dokumentaatiota uusilla lisäyksillä tai päivityksillä. Jatkossa, jos päivitämme dokumenttia, myös dokumentin nimi ja esitystapa verkkosivulla muuttuu. Tämän lisäksi ilmoitamme kunkin dokumentin kohdalla jatkossa ainoastaan niiden uusimman julkaisupäivän. Esimerkiksi, jos Tulossa olevat muutokset -sivulla olevaa luoton tietojen ilmoittamisen rajapintakuvausta tulisi päivittää vielä ennen kuin se julkaistaan Tuotannon dokumentaatio -sivulla, nimeäminen menisi seuraavasti:

• Luoton tietojen ilmoittaminen – rajapintakuvaus (pdf) versio 2.2. Dokumentti julkaistu 1.4.2026.
• Luoton tietojen ilmoittaminen – rajapintakuvaus (pdf) versio 2.2.rev1. Dokumentti julkaistu xx.xx.xxxx.
• Luoton tietojen ilmoittaminen – rajapintakuvaus (pdf) versio 2.2.rev2. Dokumentti julkaistu xx.xx.xxxx.
• ja niin edelleen

Jatkossa varmistamme myös sen, että versionumero näkyy myös dokumentin verkko-osoitteessa. Uudistukset tulevat voimaan Tulossa olevat muutokset-sivulla 1.9.2026 jälkeen julkaistavissa dokumenteissa.

Tuotannon dokumentaatio säilyy ennallaan

Uudet käytännöt eivät vaikuta Tuotannon dokumentaatio -sivulla julkaistavaan tuotannon dokumentaatioon. Tuotannossa versionumerointi säilyy ennallaan.