Spelregels Afspraken en Standaarden

Deze pagina is vastgesteld door Architectuurraad, op 20 april 2023.

Bekijk ook Afspraak en Standaard in het ROSA metamodel voor meer informatie over deze typen architectuurelementen.

Inleiding[bewerken]

In de ROSA maken we onderscheid tussen standaarden en afspraken:

Standaarden zijn generieke, breed toepasbare elementen die als bouwstenen kunnen worden ingezet in verschillende contexten.
Afspraken (en afsprakenstelsels) zijn specifieke toepassingen van standaarden binnen bepaalde ketensamenwerkingen en ketenvoorzieningen.

Dit onderscheid helpt om:

De hiërarchie en samenhang tussen standaarden en afspraken beter weer te geven
De flexibiliteit in het gebruik van standaarden binnen verschillende afspraken te benadrukken
Een duidelijker beeld te schetsen van hoe generieke standaarden worden vertaald naar specifieke toepassingen in de onderwijspraktijk

Criteria voor opname[bewerken]

Criteria voor Standaarden[bewerken]

Een standaard wordt alleen opgenomen als deze is gepubliceerd op Edustandaard.nl met status "geregistreerd" of "aangemeld".
Standaarden van Forum Standaardisatie worden niet direct in ROSA opgenomen. Er wordt alleen naar verwezen wanneer deze semantisch relevant zijn voor een ROSA model.
Uitzondering hierop zijn de standaarden die geregistreerd zijn bij Edustandaard.nl als een profiel of onderdeel daarvan gericht voor het onderwijs. Bijvoorbeeld TLS is voor het onderwijs geregistreerd onder de afspraak UBV-TLS.
Voor internationale standaarden geldt hetzelfde: deze worden alleen opgenomen als ze specifiek zijn geprofileerd voor het onderwijs en zijn geregistreerd bij Edustandaard. Of wanneer deze nodig zijn voor het uitwerken van een view.

Criteria voor Afspraken[bewerken]

Een afspraak wordt alleen opgenomen als deze is gepubliceerd op Edustandaard.nl met status "geregistreerd" of "aangemeld".
Een afspraak moet een concreet gebruiksadvies hebben van Edustandaard: "verplicht", "aangeraden", "onbekend" of "onder voorwaarden".
Afspraken met beheerstatus "uit registratie" of "afgewezen" worden niet opgenomen.
Afspraken met gebruiksadvies "afgeraden" worden niet opgenomen.
Afspraken moeten altijd gekoppeld kunnen worden aan concrete ketenprocessen of referentiecomponenten.

Spelregels voor redactie[bewerken]

Bij externe standaarden wordt alleen verwezen naar de bron (Forum Standaardisatie, internationale standaardisatie-organisaties).
Er wordt minimale informatie handmatig overgenomen - alleen wat nodig is voor verwijzing en context.
De uitgebreide beschrijving van een afspraak of standaard staat op de Edustandaard website. Vanaf de ROSA wordt hiernaar verwezen.
Iedere afspraak of standaard wordt ingedeeld in één of meerdere ROSA keten- of IV-domeinen.
iedere standaard wordt geplot op het ROSA interoperabiliteitsraamwerk
Bij wijzigingen in de lijst van afspraken en standaarden, wordt vanuit Bureau Edustandaard een notificatie gegeven aan het ROSA Beheerteam.
Minimaal jaarlijks voor de eerste Architectuurraad wordt de lijst met afspraken en standaarden bijgewerkt conform Edustandaard.
Bij vervanging van een afspraak of standaard wordt de plaatsing in alle ROSA views herzien.

Attributen[bewerken]

Naast een beschrijving en attributen worden er ook relaties gelegd met andere mogelijke architectuurentiteiten (zoals beschreven in het metamodel). Die relaties worden niet als attributen weergegeven, want die zijn al zichtbaar in het gegenereerde "plaatje" onder de balk 'Meer informatie'.

Aanduiding[bewerken]

Attribuut: Naam
Omschrijving	De aanduiding waaronder de afspraak bekend staat. Deze moet zowel de essentie van de regel representeren, als makkelijk te onthouden zijn.
Toelichting	Als de afkorting zeer gangbaar is in communicatie/documentatie dan wordt die ook tussen haakjes achter de volledige aanduiding opgenomen.
Voorbeelden	Afspelen educatieve content, Edukoppeling, Hoger Onderwijs Voorlichtings Informatie (HOVI)
Kardinaliteit	1..1
Verwerken in Archi	In te vullen in de sectie Main onder Name

Attribuut: Afkorting
Omschrijving	Een notatie of code die als verkorte aanduiding van de afspraak fungeert
Toelichting	Als de afkorting zeer gangbaar is in communicatie/documentatie dan wordt die ook tussen haakjes achter de volledige aanduiding opgenomen bij het attribuut Aanduiding.
Voorbeelden	CEVO, HOVI, iUD
Kardinaliteit	0..1
Verwerken in Archi	In te vullen als Value in de sectie Properties bij Name “Afkorting”

Betekenis[bewerken]

Attribuut: Beschrijving
Omschrijving	Omschrijving van de afspraak
Toelichting	De omschrijving is beperkt tot 1 tot 2 zinnen. Is meer informatie gewenst dan opnemen in toelichting.
Voorbeelden	-
Kardinaliteit	1..1
Verwerken in Archi	In te vullen in de sectie Main onder Documentation. Overnemen van de korte beschrijving van de Edustandaard-website cq Forum Standaardisatie-website (zoals getoond in de lijst van afspraken/standaarden).

Attribuut: Type
Omschrijving	De aanduiding van het type van object / modelentiteit in het ROSA-metamodel.
Toelichting	Afspraak is een modelentiteit in het ROSA Metamodel. Door dit als attribuut expliciet op te nemen bij de beschrijving wordt de samenhang met het metamodel voor de gebruiker meteen duidelijk. Bovendien wordt dit attribuut gebruikt bij het kunnen samenstellen van views en pagina's.
Mogelijke waarde(n)	Afspraak
Kardinaliteit	1..1
Verwerken in Archi	In te vullen als Value in de sectie Properties bij Name “Type”

Attribuut: Toelichting
Omschrijving	Inhoudelijke toelichting op de omschrijving van de afspraak en/of nadere details
Toelichting	Regel is dat een toelichting alleen nodig is, als de afspraak niet binnen Edustandaard of Forum Standaardisatie is geregistreerd. In alle andere gevallen is de toelichting te vinden op de website van Edustandaard cq Forum Standaardisatie. Uitzondering hierop is als een nadere duiding in de context van de ROSA relevant is voor het gebruik.
Voorbeelden	-
Kardinaliteit	0..1
Verwerken in Archi	In te vullen als Value in de sectie Properties bij Name “Toelichting”

Herkomst[bewerken]

Attribuut: Externe verwijzing
Omschrijving	URL waar de uitleg/documentatie van de afspraak of standaard te vinden is.
Toelichting	Bij afspraak of standaard geregistreerd door Edustandaard: URL naar pagina op Edustandaard waar de afspraak of standaard staat gedocumenteerd. Dit is een link naar de bron van de afspraak op Edustandaard waar verdere beschrijving en documentatie is opgenomen. Idem voor de standaarden van het Forum Standaardisatie. Bij andere afspraken: De vermeende hoofd-URL waar de afspraak te vinden is.
Voorbeelden	https://www.edustandaard.nl/standaard_afspraken/edukoppeling-transactiestandaard
Kardinaliteit	1..1
Verwerken in Archi	In te vullen als Value in de sectie Properties bij Name “Externe verwijzing”

Attribuut: Registrerende organisatie
Omschrijving	De organisatorische entiteit waar de afspraak of standaard geregistreerd is.
Toelichting	Bij de registrerende organisatie zal zoveel mogelijk ook de beschrijving worden opgehaald dan wel ter controle voorgelegd. In het geval van afspraken of standaarden die op Edustandaard.nl worden gepubliceerd is de registrerende organisatie Edustandaard. Het daadwerkelijke beheer ligt vaak bij een werkgroep die dit beheer conform het beheerproces en condities van Edustandaard uitvoert. Voor deze detailinformatie wordt verwezen naar Edustandaard.nl
Voorbeelden	Edustandaard, Forum Standaardisatie, 1EdTech
Kardinaliteit	1..1
Verwerken in Archi	In te vullen als Value in de sectie Properties bij Name “Registrerende organisatie”
Herkomst	www.edustandaard.nl

Attribuut: Registratiestatus
Omschrijving	De verschillende fases in de levenscyclus van een afspraak of standaard (dus niet een versie) die bij Edustandaard zijn aangemeld of geregistreerd zijn (of dat waren).
Toelichting	Het gaat om afspraken of standaarden die op Edustandaard.nl zijn gepubliceerd. Zie ook: Uitleg filters Edustandaard Voor afspraken of standaarden die niet bij Edustandaard.nl voorkomen wordt vooralsnog de registratiestatus niet ingevuld.
Mogelijke waarde(n)	Aangemeld, Geregistreerd, Afgewezen, Ingetrokken, Einde registratie (NB andere registratiestatussen leiden niet tot een opname in de ROSA)
Kardinaliteit	0..1
Verwerken in Archi	In te vullen als Value in de sectie Properties bij Name “Registratiestatus”

Gebruik[bewerken]

Attribuut: Werkingsgebied
Omschrijving	Het domein (organisatorisch, taakvelden) binnen het onderwijs waarin de afspraak of standaard wordt of kan worden toegepast.
Toelichting	Werkingsgebied is niet exact gelijk aan de wettelijke indeling van de onderwijssectoren. Het speciaal onderwijs bijvoorbeeld is een apart werkingsgebied binnen ROSA, dat wettelijk gezien deel uitmaakt van de sector (en werkingsgebied) primair onderwijs.
Mogelijke waarde(n)	Zie Werkingsgebieden
Kardinaliteit	1..*
Verwerken in Archi	In te vullen als Value in de sectie Properties bij Name “Werkingsgebied”. Per werkingsgebied wordt een property aangemaakt.

Attribuut: Gebruiksadvies
Omschrijving	Aanwijzing of de afspraak of standaard moet, kan of juist liever niet moet worden gebruikt.
Toelichting	Voor afspraken of standaarden gepubliceerd op Edustandaard.nl: de aanwijzing komt van de Edustandaard Standaardisatieraad. Zie ook: https://www.edustandaard.nl/afspraken/uitleg-filters/#Gebruiksadvies Voor afspraken of standaarden die niet bij Edustandaard zijn geregistreerd en ook niet bij Forum Standaardisatie worden geen gebruiksadviezen vastgelegd.
Mogelijke waarde(n)	Verplicht, Aangeraden, Onder voorwaarden, Onbekend, Afgeraden
Kardinaliteit	1..1
Verwerken in Archi	In te vullen als Value in de sectie Properties bij Name “Gebruiksadvies”