Teknistä ja säänneltyä dokumentaatiota koskevat vaatimukset: sääntelyvyyhdin ymmärtäminen

Sääntelyvaatimusten noudattaminen on kiinteä osa tuotedokumentaatiota

Säännellyillä toimialoilla dokumentaation tehtävä ei ole sisällön tukeminen. Se on osa tuotteen vaatimustenmukaisuusarkkitehtuuria. Tähän sisältyy se, mitä monet organisaatiot kutsuvat tekniseksi dokumentaatioksi, mutta myös säännelty ja tuotetietoja koskeva dokumentaatio:

• käyttöohjeet

• huoltokäsikirjat

• turvallisuuteen liittyvät varoitukset

• tuotemerkinnät ja pakkaustiedot

• huoltotiedotteet

• viranomaisille toimitettavat aineistot.

Nämä materiaalit ovat suoraan sidoksissa seuraaviin:

• tuotteiden hyväksyntä

• markkinoille pääsy

• auditointien tulokset

• oikeudellinen vastuu

• sopimusvelvoitteet (esim. tuotteiden turvallinen käyttö, ohjeet ja toimitusten vaatimustenmukaisuus)

• käyttäjäkokemus ja turvallinen käyttö ohjelmistoympäristöissä (mukaan lukien työterveyteen ja ‑turvallisuuteen liittyvät näkökohdat).

Dokumentaation epäonnistuessa myös sääntelyn noudattaminen pettää.

Monimutkaisissa teknisen ja säännellyn dokumentaation ympäristöissä toimiville tiimeille sääntelyn noudattaminen on harvoin kiinni yksittäisestä säännöstä tai standardista. Sen sijaan se rakentuu useista päällekkäisistä hallintakerroksista, jotka määrittävät, miten dokumentaatiota luodaan, jäsennetään, käännetään ja suojataan. Yhdessä nämä kerrokset muodostavat asian, jota voidaan kutsua teknisen dokumentaation sääntelykokonaisuudeksi.

Tämän kokonaisuuden ymmärtäminen auttaa selittämään, miksi dokumentaatiotyönkulut ovat säännellyillä toimialoilla tiukan ohjauksen alaisia, miksi monikielinen sisältö edellyttää tarkkoja validointiprosesseja ja miksi dokumentaatiojärjestelmiin rakennetaan vahvoja hallintamekanismeja.

Globaaleissa organisaatioissa näistä haasteita tulee vielä monimutkaisempia. Tuotedokumentaatiota pitää usein tuottaa, ylläpitää ja validoida monikielisesti useilla markkina-alueilla ja erilaisissa sääntely-ympäristöissä. Päivityksiä tarvitaan tuotteiden muuttuessa, sääntelyn kehittyessä tai siirryttäessä uusille markkinoille, jolloin on tarpeen varmistaa vaatimustenmukaisuuden ja turvallisen käytön jatkuminen.

On tärkeää huomata, että kaikki organisaatiot eivät kohtaa kaikkia tässä artikkelissa kuvattuja tapauksia. Standardien, säädösten ja dokumentaatiovaatimusten tarkka yhdistelmä riippuu vahvasti toimialasta, tuotetyypistä sekä yrityksen toimintaan liittyvästä sääntely-ympäristöstä.

Esimerkkejä:

• Lääkinnällisiä laitteita valmistavan yrityksen toimintaan voidaan soveltaa ISO 13485 ‑standardin ja EU:n MDR-asetuksen vaatimuksia, jolloin dokumentaation on täytettävä tiukat sääntelyvaatimukset ja se tulee kääntää niiden markkina-alueiden virallisille kielille, joilla laitetta myydään.

• Ilmailu- ja avaruusteollisuuden organisaatiot voivat noudattaa S1000D-standardia sekä vientivalvontakehyksiä, kuten ITAR ja EAR.

• Autoteollisuuden yritykset voivat toimia TISAX-tietoturvavaatimusten mukaisesti.

• Kulutustavaroiden valmistajia voivat ohjata esimerkiksi EU:n kosmetiikka-asetuksen 19 artiklan kaltaiset säädökset.

Dokumentaatiovaatimukset vaihtelevat merkittävästi eri toimialoilla. Lue, miten LanguageWire tukee organisaatioita säännellyillä toimialoilla, kuten biotieteissä, autoteollisuudessa, teollisuudessa ja teknologia-alalla.

Näille ympäristöille on kuitenkin yhteistä se, että dokumentaation vaatimustenmukaisuus perustuu harvoin mihinkään yksittäiseen sääntöön. Se rakentuu useista hallinta- ja sääntelykerroksista, jotka ovat vuorovaikutuksessa dokumentaatiojärjestelmien kanssa.

Korkealla tasolla sääntelykokonaisuutta voidaan kuvata neljän keskenään vuorovaikutuksessa olevan kerroksen avulla:

1. Hallintakehykset, jotka ohjaavat dokumentointiprosesseja

2. Tuotesäädökset, jotka määrittävät dokumentaation pakollisen sisällön

3. Dokumentaatioarkkitehtuurin standardit, jotka ohjaavat tiedon jäsentämistä ja hallintaa

4. Tieto- ja tietoturvakehykset, jotka ohjaavat dokumentaatioon pääsyä sekä sen tallentamista ja siirtämistä

Nämä kerrokset rakentuvat toistensa varaan. Hallintakehykset määrittävät, miten dokumentointiprosessit toimivat. Tuotesäädökset määrittävät, mitä tietoja dokumentaation tulee sisältää. Dokumentaatioarkkitehtuurin standardit määrittävät, miten tätä tietoa jäsennetään ja käytetään uudelleen. Tieto- ja tietoturvakehykset määrittävät, missä dokumentaatiota säilytetään ja kenellä on pääsy siihen.

Yhdessä ne muodostavat vaatimustenmukaisuusarkkitehtuurin, joka tukee nykyaikaisia teknisen ja säännellyn dokumentaation ympäristöjä.

Dokumentaation sääntelykokonaisuuden neljä kerrosta

Tämä malli auttaa ymmärtämään, miten dokumentaation hallinta, sääntelyvelvoitteet ja tekniset järjestelmät kytkeytyvät toisiinsa säännellyissä ympäristöissä.

1. Hallintakerros: ISO-kehykset ja hallitut prosessit

Useimmat monimutkaista tuotedokumentaatiota hallinnoivat yritykset toimivat ISO-pohjaisen laadunhallintajärjestelmän mukaisesti. Nämä kehykset määrittävät, miten prosesseja tulee dokumentoida, hallita ja auditoida. Tässä muutama esimerkki:

• ISO 9001 – laadunhallinta ja prosessien hallinta

• ISO 13485 – lääkinnällisten laitteiden laadunhallintajärjestelmät

• ISO 17100 – käännöspalvelut ja kieliin liittyvät työnkulut

• ISO 18587 – konekäännöksen jälkieditointi

• ISO 27001 – tietoturvan hallinta

Nämä standardit edellyttävät, että yritykset ylläpitävät

• dokumentoituja menettelyohjeita

• määriteltyjä tarkistus- ja hyväksyntävastuita

• versionhallintaa

• jäljitettävyyttä

• riskiperusteista validointia.

Säännellyissä ympäristöissä toimivien organisaatioiden on myös varmistettava, että dokumentaation ja lokalisoinnin työnkulut toteutetaan turvallisessa infrastruktuurissa ja hallituissa tietoympäristöissä.

Käytännössä tämä tarkoittaa sitä, että dokumentaatiotyönkulut eivät voi toimia epävirallisina sisältöprosesseina. Ne ovat osa hallittua laadunhallintajärjestelmää. Jokaisen vaiheen sisällöntuotannosta kääntämiseen, validointiin ja julkaisemiseen on oltava jäljitettävissä ja auditoitavissa.

Tämä hallintakerros muodostaa dokumentaation vaatimustenmukaisuuden perustan. Hallintakehykset eivät kuitenkaan yksinään määritä, mitä dokumentaation tulee sisältää. Tämä vastuu määräytyy tuotekohtaisten sääntelykehysten perusteella.

2. Tuotesääntelyn kerros: markkinoillepääsyn ja turvallisuuden viitekehykset

Kun dokumentointiprosessit ovat hallinnassa, seuraava kerros määrittää itse tuotteeseen liittyviä sääntelyvelvoitteita. Ne määrittävät, millaisia tietoja tuotteen yhteydessä on annettava sekä miten ja millä kielillä ne on esitettävä.

EU:n asetus lääkinnällisistä laitteista (MDR-asetus, 2017/745)

Lääkinnällisistä laitteista annetun EU:n asetuksen mukaan tekninen dokumentaatio on osa koko elinkaaren kattavaa sääntelykehystä, joka ohjaa lääkinnällisten laitteiden turvallisuutta ja suorituskykyä.

MDR-asetukseen sisältyvät

• suunnittelu ja kehittäminen

• kliininen arviointi

• vaatimustenmukaisuuden arviointi

• markkinoille tulon jälkeinen valvonta

• jatkuva seuranta.

Siinä käsiteltiin myös yksilöllisen laitetunnisteen (UDI) käyttöä, ilmoitettujen laitosten valvonnan tiukentamista sekä soveltamisalan laajentamista koskemaan tiettyjä ohjelmistotuotteita ja ei-lääketieteellisiä tuotteita.

Käytännössä tämä tarkoittaa sitä, että

• käyttöohjeiden on oltava tarkkoja kaikilla tarvittavilla kielillä

• käännösvirheet voivat vaikuttaa CE-merkintään

• dokumentaation päivitykset voivat johtaa sääntelyyn liittyvään arviointiin

• markkinoille tulon jälkeiset vaaratilanteet voivat johtaa monikielisen dokumentaation tarkasteluun.

Dokumentaatiossa ei siis ole kyse pelkästä tiedon esittämisestä. Se on osa tuoteturvallisuusjärjestelmää.

EU:n kosmetiikka-asetuksen 19 artikla

Vastaavaa periaatetta sovelletaan kosmetiikka-alalla. 19 artikla edellyttää pakollisia tuotetietoja, joita ovat muiden muassa

• vastuuhenkilön tiedot

• ainesosien luettelo INCI-nimillä

• varoitukset ja varotoimenpiteet

• tuotteen tarkoitus.

Nämä tiedot tulee esittää pakkauksessa selvällä ja pysyvällä tavalla. Lisäksi ne tulee antaa sen jäsenvaltion virallisilla kielillä, jossa tuotetta myydään.

Uudemman yleisen tuoteturvallisuusasetuksen (GPSR-asetus, 2023/988) mukaan näiden tietojen tulee myös olla saatavilla verkossa ennen ostoa.

Vastaavia vaatimuksia on myös lääketeollisuudessa, jossa esimerkiksi Euroopan lääkeviraston (EMA) antamat ohjeet edellyttävät, että pakkausselosteet, pakkausmerkinnät ja turvallisuustiedot esitetään kunkin markkina-alueen virallisilla kielillä.

Toimialakohtaisten säädösten lisäksi myös kansainvälistä kauppaa ja tulleja koskevat vaatimukset on otettava huomioon. Dokumentaation, kuten käyttöturvallisuustiedotteiden, lähetysasiakirjojen ja tuoteselosteiden, on usein täytettävä maakohtaiset kieli- ja sääntelyvaatimukset, jotta tuotteet voidaan laillisesti tuoda maahan, tullata ja saattaa jakeluun.

Sekä MDR-asetuksessa, 19 artiklassa että muissa asiaan liittyvissä säädöksissä kääntäminen on muutakin kuin pelkkää markkinointia. Se on myymisen oikeudellinen edellytys.

Kun sääntelyvelvoitteet on määritelty, organisaatioiden on varmistettava, että niiden dokumentaatiojärjestelmät pystyvät tuottamaan johdonmukaisesti vaatimustenmukaista tietoa eri tuotteista ja versioista eri kielillä. Tässä dokumentaatiojärjestelmien arkkitehtuuri nousee keskeiseen rooliin.

3. Dokumentaatioarkkitehtuurin kerros: rakenteisen julkaisemisen standardit

Monimutkaisilla toimialoilla vaatimustenmukaisuus vaatii muutakin kuin oikeita sanamuotoja. Se vaatii sitä, että dokumentaation rakenne ja hallinta on toteutettu oikealla tavalla. Monet organisaatiot hallitsevat teknistä ja säänneltyä dokumentaatiota rakenteista sisältöä koskevien viitekehysten kautta, joita ovat esimerkiksi

• S1000D, ilmailu, avaruus- ja puolustusteollisuudessa käytettävä standardi rakenteisen teknisen dokumentaation luomiseen ja hallintaan

• DITA ja muut XML-pohjaiset dokumentaatiostandardit, jotka mahdollistavat modulaarisen ja uudelleenkäytettävän sisällön, jota voidaan päivittää kerralla ja hyödyntää uudelleen useissa asiakirjoissa, kanavissa ja kielissä

• Rakenteiset komponenttipohjaiset sisällönhallintajärjestelmät (CCMS), jotka tukevat skaalautuvaa sisällöntuotantoa, sisällön uudelleenkäyttöä ja lokalisointia. Käytännössä sisältö kuitenkin usein jaetaan eri järjestelmiin, kuten PIM-, ERP- ja CMS-järjestelmiin, mikä heijastaa erilaisia käyttöönoton ja organisaation kypsyyden vaiheita.

Nämä viitekehykset jäsentävät dokumentaation uudelleenkäytettäviin moduuleihin, jotka tallennetaan yhteiseen lähdetietokantaan (CSDB) tai CCMS-järjestelmään. Jokainen moduuli sisältää

• tunniste- ja tilametatietoja

• soveltuvuuden hallintatietoja

• rakenteisia sisältötyyppejä, kuten menettelyohjeita, vianetsintätietoja tai kuvitettuja osia.

Tämän modulaarisen arkkitehtuurin ansiosta dokumentaatiota voidaan käyttää uudelleen

• eri tuoteversioissa

• huolto-ohjelmissa

• elinkaaren eri vaiheissa

• useissa julkaisukanavissa.

Siitä seuraa myös tiukkoja rakennevaatimuksia. Näissä ympäristöissä

• metatietojen eheys on kriittisen tärkeää

• XML-skeemojen on pysyttävä ehjinä

• terminologian on vastattava määritettyjä sanastoja

• sisällön päivitykset voivat näkyä useissa eri julkaisuissa, erityisesti tilanteissa, joissa esimerkiksi korjauttamisoikeutta koskeva EU-sääntely lisää päivitystarpeita ja pidentää sisällön elinkaarta.

Siksi vaatimustenmukaisuus ei ole pelkästään oikeita sanamuotoja. Se on myös data-arkkitehtuuria ja rakenteisen julkaisemisen eheyttä. Kuitenkin selkeärakenteisetkin dokumentointijärjestelmät joutuvat toimimaan niiden sääntöjen puitteissa, jotka ohjaavat dokumentaation sisältämän tiedon tallentamista, käyttöä ja siirtämistä.

4. Datan ja tietoturvan kerros: tiedonhallinta ja vientivalvonta

Dokumentaatioarkkitehtuurin lisäksi organisaatioiden on varmistettava, että dokumentaatiotyönkulkuja tukeva infrastruktuuri täyttää tietosuojaa, tietoturvaa ja vientivalvontaa koskevat vaatimukset.

GDPR

Yleinen tietosuoja-asetus (GDPR) säätelee henkilötietojen käsittelyä EU:n alueella sekä EU:n jäsenvaltioiden rekisteröityjä palvelevien organisaatioiden toiminnassa. Tekninen ja säännelty dokumentaatio voi sisältää seuraavanlaisia henkilötietoja:

• insinöörien tai kirjoittajien nimet

• tutkijoiden tiedot

• yhteystiedot

• auditointien metatiedot.

GDPR vaatii organisaatioita noudattamaan seuraavia periaatteita:

• lainmukaisuus, kohtuullisuus ja läpinäkyvyys

• käyttötarkoitussidonnaisuus

• tietojen minimointi

• täsmällisyys

• säilytyksen rajoittaminen

• eheys ja luottamuksellisuus (eli henkilötietojen asianmukainen turvallisuus)

• osoitusvelvollisuus.

Rekisteröidyillä on myös oikeus saada pääsy itseään koskeviin tietoihin sekä pyytää niiden oikaisemista tai poistamista. Siksi dokumentointijärjestelmissä ja lokalisoinnin työnkuluissa on varmistettava, että henkilötietoja käsitellään näiden vaatimusten mukaisesti.

ITAR ja EAR

Puolustusteollisuudessa ja kaksikäyttötuotteisiin liittyvillä aloilla dokumentaatio voi sisältää myös vientivalvonnan alaista teknistä tietoa.

Tähän sovelletaan kahta keskeistä Yhdysvaltain vientivalvontakehystä:

• ITAR (International Traffic in Arms Regulations), joka koskee US Munitions List -luettelossa olevia puolustukseen liittyviä tuotteita

• EAR (Export Administration Regulations), joka koskee vientivalvontaluokitusnumerolla (Export Control Classification Number) luokiteltuja kaksikäyttötuotteita.

Vientivalvonta koskee fyysisen viennin lisäksi myös digitaalista siirtoa ja pilvipohjaista käyttöä. Valvotun teknisen dokumentaation lataaminen ulkomailla ylläpidettäviin järjestelmiin voidaan näiden säädösten nojalla katsoa vienniksi. Tästä syystä pääsynhallinta ja infrastruktuurin hallinta muodostavat tärkeän osan dokumentaation vaatimustenmukaisuuden varmistamista.

TISAX

Autoteollisuudessa organisaatiot voivat toimia myös TISAX (Trusted Information Security Assessment Exchange) ‑tietoturvavaatimusten mukaisesti. TISAX on toimialakohtainen viitekehys, jonka avulla voidaan validoida tietoturvakäytäntöjä toimittajien ja kumppaneiden välillä.

Arkaluonteista suunnitteludokumentaatiota tai teknisiä määrityksiä käsittelevät yritykset voivat edellyttää TISAX-arvioituja ympäristöjä turvallisen tiedonkäsittelyn ja hallitun tiedonsiirron osoittamiseksi.

Miksi sääntelykokonaisuuden ymmärtäminen on tärkeää

Dokumentaatioon sovellettavia sääntelykehyksiä käsitellään usein erikseen. Käytännössä niillä kuitenkin on yhtymäkohtia oikeiden dokumentointiympäristöjen sisällä.

Teknisen ja säännellyn dokumentaation työnkulut sijoittuvat kohtaan, jossa

• hallintakehykset ohjaavat prosesseja

• tuotesäädökset määrittävät, mitkä tiedot ovat pakollisia

• rakenteiset dokumentaatiojärjestelmät hallitsevat sisältöarkkitehtuuria

• tietosuoja- ja tietoturvasäännöt hallitsevat pääsyä tietoihin.

Nämä yhtymäkohdat muodostavat dokumentaation sääntelykokonaisuuden. Pohjimmiltaan tämän kokonaisuuden tarkoituksena on tukea ensisijaista päämäärää: turvallista ja vaatimustenmukaista tuotteiden ja järjestelmien käyttöä niin työntekijöiden, työnantajien kuin loppukäyttäjienkin kannalta. Tämän kokonaisuuden ymmärtäminen on entistä tärkeämpää, kun dokumentaatiotyönkulut kehittyvät.

Nykyaikaisissa dokumentointiympäristöissä on usein

• rakenteisia sisällöntuotantoalustoja

• automatisoituja lokalisointiprosesseja

• termienhallintajärjestelmiä

• konekäännös- ja jälkieditointityönkulkuja

• tekoälyavusteisia editointi- ja laadunarviointityökaluja.

Tällaiset teknologiat voivat parantaa tehokkuutta merkittävästi. Ne ovat kuitenkin myös suorassa vuorovaikutuksessa niiden hallintarakenteiden kanssa, jotka varmistavat tuoteturvallisuuden, lainsäädännön noudattamisen ja tietoturvan.

Kun nämä kerrokset eivät ole linjassa keskenään, sillä voi olla tuntuvia seurauksia, kuten tuotteiden hyväksynnän viivästyminen, virheellinen käyttö tai jopa työtapaturmat, jotka johtuvat epäselvistä tai huonosti lokalisoiduista ohjeista.

Tehokkaan ja lokalisoidun dokumentaation piilevä arvo perustuu sen kykyyn vähentää näitä riskejä varmistamalla, että kriittisen tärkeät tiedot välittyvät selkeästi eri kielille, markkina-alueille ja käyttäjäryhmille.

Dokumentaatiotyönkulkujen suunnittelu näiden kerrosten mukaisesti on yksi suurimmista haasteista, joita organisaatiot kohtaavat skaalatessaan monikielistä teknistä ja säänneltyä dokumentaatiota.

Yhteenveto

Säännellyillä toimialoilla dokumentaatio on muutakin kuin sisältöä. Se on osa tuotteen turvallisuuteen ja vaatimustenmukaisuuteen liittyvää oikeudellista kehystä.

Tämä kehys rakentuu useista hallinnan, sääntelyn, rakenteisen julkaisemisen ja tietoturvan kerroksista. Tämän dokumentaation sääntelykokonaisuuden ymmärtäminen on olennaisen tärkeää kaikille organisaatioille, jotka hallinnoivat monimutkaista ja monikielistä teknistä ja säänneltyä dokumentaatiota.

Tämä johtuu siitä, että kun dokumentaatio toimii näyttönä vaatimustenmukaisuudesta, jokainen sen tuottamiseen liittyvä työnkulku, järjestelmä ja prosessi on suunniteltava samantasoista hallintaa käyttäen.

Kohdistuuko yrityksesi dokumentointiympäristöön muita sääntelyvaatimuksia?

Tässä käsitellyt kehykset ovat yleisiä säännellyillä toimialoilla. Käytännössä monien organisaatioiden toimintaan kohdistuu muitakin dokumentaatio-, turvallisuus- tai tietoturvavaatimuksia.

LanguageWire tekee yhteistyötä monenlaisissa säännellyissä ympäristöissä toimivien tiimien kanssa ja tukee lokalisoinnin työnkulkuja ja prosesseja, jotka auttavat organisaatioita täyttämään dokumentaatiota ja sääntelyn noudattamista koskevat vaatimukset.

Tee monikielisestä teknisestä dokumentaatiosta yksinkertaisempaa tinkimättä vaatimustenmukaisuudesta

LanguageWire auttaa globaaleja yrityksiä hallitsemaan monimutkaisia dokumentointiympäristöjä yhdistämällä rakenteisen sisällön asiantuntemuksen tekoälyä hyödyntäviin toimintoihin, kuten tekoälypohjaiseen laadunarviointiin (AIQE) ja editointiin (AIE) sekä omaan konekääntimeensä, kieliasiantuntijoiden ohella.

Tämä mahdollistaa tehokkaammat lokalisoinnin työnkulut ja ylläpitää samalla hallintaa, yhdenmukaisuutta sekä tietosuoja- ja sääntelyvaatimusten noudattamista.