Help/nieuwe standaard aanmaken

Uit NORA Online
Ga naar: navigatie, zoeken
logo helpsectie, twee vraagtekens en de knoppen F1 en help in de kleuren van NORA (blauw, wit en paars)
Helpsectie NORANederlandse Overheid ReferentieArchitectuur wiki:


Deze pagina beschrijft de methode om een nieuwe standaard toe te voegen aan de NORANederlandse Overheid ReferentieArchitectuur. NB: dit is alleen mogelijk voor gebruikers die extra rechten hebben.

Inhoud

Beleid wat betreft de opname van standaarden in NORANederlandse Overheid ReferentieArchitectuur

De NORANederlandse Overheid ReferentieArchitectuur geeft niet alle bestaande standaarden weer, maar alleen standaarden die:

  • Op een van de lijsten staan van het Forum Standaardisatie

en/of

  • In de praktijk gebruikt worden door en binnen overheidsorganisaties

en/of

  • Aanbevolen worden door inhoudelijk experts omdat ze bijdragen aan interoperabiliteitInteroperabiliteit is het vermogen van organisaties (en hun processen en systemen) om effectief en efficiënt informatie te delen met hun omgeving (in de publieke sector of een onderdeel daarvan)

en/of

  • Aanbevolen worden vanuit een thema of vraagstuk omdat ze bijdragen aan de kwaliteit van dienstverlening

Waar komt de informatie over standaarden vandaan?

Voor standaarden die op een van de lijsten van het Forum Standaardisatie staan geldt het Bureau Forum Standaardisatie als primaire bron, met doorverwijzing naar de beheerders. Dat zorgt voor uniforme beschrijvingen binnen de digitale overheid. Voor andere standaarden geldt de site van de beheerder of de standaard zelf als primaire bron. De informatie van de primaire bron kan verrijkt worden met extra toelichting (bijvoorbeeld vanuit het thema dat een standaard aandraagt), relaties met andere NORA-elementen, en vanuit secundaire bronnen zoals de Monitor Open Standaardenbeleid.

Wie mag een nieuwe standaard toevoegen?

Standaarden vanuit Bureau Forum Standaardisatie worden door NORANederlandse Overheid ReferentieArchitectuur Beheer semi-automatisch toegevoegd. Overheidsorganisaties die andere standaarden gebruiken en deze in de NORANederlandse Overheid ReferentieArchitectuur opgenomen willen zien kunnen het beste even contact opnemen met NORANederlandse Overheid ReferentieArchitectuur Beheer. Inhoudelijk contactpersonen van de Thema's mogen in principe zelf standaarden toevoegen aan de wiki, in overleg met NORANederlandse Overheid ReferentieArchitectuur Beheer.

Stappenplan toevoegen standaard

screenshot van de pagina Standaard, met een groene cirkel om het invoerveld na de kop Elementen van dit type.
Screenshot van de pagina Standaard, in groen aangegeven waar je de naam van de nieuwe standaard in moet vullen

Check op dubbelingen

Kijk eerst goed in de lijst met alle standaarden in de wiki of de standaard die je wilt toevoegen er niet al met een net andere spellingswijze in staat. Een veelvoorkomende dubbeling ontstaat als de afkorting en de volledige naam apart van elkaar worden aangemaakt. NORANederlandse Overheid ReferentieArchitectuur volgt hier de primaire bron (Bureau Forum Standaardisatie, of de beheerder van de standaard), dus doe dat ook met nieuwe standaarden.

Bestaat de standaard al wel, maar kun je hem slecht vinden doordat een alternatieve spellingswijze meer gebruikelijk is, neem dan even contact op met NORANederlandse Overheid ReferentieArchitectuur Beheer of maak zelf een nieuwe pagina aan met de gebruikelijke naam, die doorverwijst naar de officiële pagina. Bezoekers die zoeken op de gebruikelijke naam worden zo rechtstreeks doorgeleid naar de juiste pagina. Er kunnen meerdere doorverwijzingen aangemaakt worden naar dezelfde standaard.

Bepaal de juiste benaming voor de standaard

Veel standaarden kennen verschillende schrijfwijzen (hoofdletters, kleine letters, spaties, punten) of worden zowel met de afkorting als met de volledige naam aangeduid. Probeer de naam over te nemen zoals de primaire bron (meestal de beheerder van de standaard) die zelf hanteert. Schrijf ook de meest voorkomende alternatieven op, zodat je daar doorverwijzingspagina's voor aan kunt maken (zie:check op dubbelingen).

Maak de standaard aan vanuit het Kennismodel

Ga naar de pagina Standaard. Scroll omlaag tot onder de kop Elementen van dit type en vul in het invoerveld de gekozen naam van de standaard in. Controleer op typefouten en klik op de knop Maak StandaardEen document dat een set van regels bevat die beschrijven hoe mensen materialen, producten, diensten, technologieën, taken, processen en systemen dienen te ontwikkelen en beheren rechts naast het invoerveld (zie screenshot hier rechts, invoerveld en knop zijn aangegeven met een groene cirkel).

Vul het invulformulier zo volledig mogelijk in

Alle eigenschappen die aan een standaard toegevoegd kunnen worden (zie de pagina Standaard voor alle eigenschappen en klik door naar de eigenschapspagina's voor meer toelichting) kun je hier invoeren in het invulformulier. Vul alleen in wat relevant is voor deze standaard èn klopt. Bij twijfel laat je de eigenschap leeg.

Enkele eigenschappen nader toegelicht: Eigenschap:ID: Het gaat hier om een extern kenmerk, dit zal dus doorgaans leeg blijven.

Eigenschap:Afkorting: Vul hier alleen de afkorting in, wanneer de naam van de standaard voluit staat geschreven.

Eigenschap:Lijst status: Het gaat hier om de status in de lijsten van het Bureau Forum Standaardisatie. Aangezien NORANederlandse Overheid ReferentieArchitectuur Beheer de standaarden van deze lijsten standaarden zelf importeert zullen thema-eigenaren hier bijna altijd kiezen voor de optie Niet bekend bij Forum Standaardisatie.

Eigenschap:Versieaanduiding: Vul hier de versie in die je aanbeveelt.

Eigenschap:Beschrijving en Eigenschap:Toelichting: Deze twee tekstvelden worden onder elkaar getoond op de uiteindelijke pagina. In overzichten van standaarden wordt over het algemeen alleen de eerste tekst weergegeven. Cruciale informatie moet daarom in de beschrijving staan, langere uitleg in de toelichting.

Eigenschap:Werkingsgebied en Eigenschap:Toepassingsgebied: Deze twee termen zijn in de historie gegroeid en niet altijd scherp gedefinieerd geweest. Gebruik het Werkingsgebied wanneer in een paar trefwoorden aan te geven is voor welke organisaties of taakvelden deze standaard in het bijzonder relevant is, bijvoorbeeld in gemeenten, Rijk, zorginstellingen of het primair onderwijs. Laat het leeg wanneer dat niet helder is. Gebruik het Toepassingsgebied om de functionele toepassing van de standaard kort weer te geven.

Eigenschap:Externe verwijzing: Zet hier de url neer waar de bezoeker het meest aan heeft, bijvoorbeeld die van de beheerder van de standaard of een externe pagina met uitleg over de standaard. Je kunt meerdere url's invoeren, gebruik als scheidingsteken uitsluitend de komma. Het is niet mogelijk om in dit vak een beschrijving bij de link te geven, of een alternatieve naam. Dit kan wel in het volgende veld: documentatie.

Eigenschap:Documentatie: Plaats hier links of interne links naar verdere documentatie over de standaard, zoals specificatiedocumenten. Maak gebruik van het tekstvak om links goed weer te geven en eventueel de context te beschrijven. Dus geen http://noraonline.nl/wiki/Bestand:Help.png, maar Plaatje bij helpsectie of Het plaatje bij de helpsectie van de NORANederlandse Overheid ReferentieArchitectuur wiki kan hergebruikt worden. Natuurlijk zou het nog logischer zijn om in dit geval de interne link te gebruiken: Plaatje bij NORA helpsectie. Gebruik voor pdfbestanden het Sjabloon:Bestand met info, zodat de bezoeker de grootte van de pdf ziet vóór het downloaden.

Eigenschap:Publicatiedatum: Vul hier de publicatiedatum in die correspondeert met de versieaanduiding. Over het algemeen komt het bij dit soort data niet op een dag of week aan, bezoekers stellen het op prijs een idee te hebben hoe lang iets al gepubliceerd is maar de precieze dag is minder relevant. Je mag er daarom voor kiezen om bij twijfel over de precieze datum een indicatie te geven, zeker als het al enige tijd geleden is. Rond bijvoorbeeld af naar 1 januari, 31 december of 1 juli van een jaar dat al is afgerond.

Eigenschap:Organisatie: Het gaat hier om de organisatie die de standaard beheert.

Eigenschap:Contactpersoon en Eigenschap:Contactgegevens: Alleen invullen als een contactpersoon binnen de Nederlandse of Europese publieke sector te vinden is, anders leeglaten. Vul bij contactpersoon de naam in en bij Contactgegevens een e-mailadres, telefoonnummer, url van contactformulier of social media-handle in. In dit veld kun je opmaak gebruiken, noteer e-mailadressen dus niet als e-mailadres@server.nl maar als e-mailadres@server.nl. NB: e-mailadres werkt wel, maar is minder toegankelijk voor diverse groepen bezoekers.

Eigenschap:Cluster: Deze indeling was oorspronkelijk gestoeld op de clusters van het Negenvlaksmodel, laat deze gerust leeg.

Eigenschap:Laag binnen vijflaagsmodel: Deze indeling is gebaseerd op het Vijflaagsmodel en wordt steeds relevanter. Vink aan op welke laag of lagen van het model de standaard functioneert. Is de standaard op geen enkele laag relevant, of twijfel je, vink dan de 0 aan (vink de 0 uit wanneer je wel een laag kiest).

Eigenschap:Nut: Geef hier aan hoe gebruik van de standaard bijdraagt aan interoperabiliteitInteroperabiliteit is het vermogen van organisaties (en hun processen en systemen) om effectief en efficiënt informatie te delen met hun omgeving en/of aan een doelstelling binnen je thema. Waarom zou je deze standaard willen of moeten gebruiken?

Eigenschap:Realiseert: Gebruik deze relatie om aan te geven dat een standaard een bepaalde doelstelling, zoals een Afgeleid Principe, (mede) realiseert. Deze relatie werd tot voor kort ook gebruikt om aan te geven of een standaard op de Lijst Open Standaarden voor Pas Toe of Leg Uit stond, nu is daar de eigenschap Lijst status voor.

Eigenschap:Is gerelateerd aan: Deze eigenschap geeft een losse, ongedefinieerde relatie weer tussen wikipagina's. Gebruik het bijvoorbeeld om standaarden die veel samen gebruikt worden te linken, of een cluster van gerelateerde ISO-normen te vormen.

Eigenschap:Is relevant binnen: Gebruik deze eigenschap om een standaard binnen een domein of een (sub-)thema te rangschikken, zodat je op de bijbehorende pagina alle standaarden, voorzieningen et cetera uit het domein of thema terug kunt zien. NB: toegestane invoer is ofwel een Domein ofwel een Categorie. Voor categorieën moet je de notering
 [[Categorie:Categorienaam]], bijv: [[Categorie:Duurzame Toegankelijkheid]] 
gebruiken. Bij domeinen is dat niet noodzakelijk. Ook hier kun je de komma gebruiken als scheidingsteken.

Opslaan en goedkeuren

Vergeet niet de pagina op te slaan, ook als je al op Bewerking ter controle bekijken hebt geklikt. Gaat het een keer mis, probeer dan in de browser op vorige te klikken, er is een grote kans dat de ingevulde informatie is opgeslagen in de buffer.

Bij het aanmaken van een nieuwe standaard is het belangrijk om de pagina na opslaan goed te keuren, ook als je nog een kleine wijziging wilt maken. Pas als de pagina is goedgekeurd kun je gebruik maken van het invulformulier in Bewerken (anders krijg je de losse code) en relaties die gelegd zijn worden pas zichtbaar in de gerelateerde pagina wanneer ze zijn goedgekeurd. De pagina verschijnt ook pas na goedkeuring in alle overzichten.

Checks na goedkeuren

Natuurlijk kijk je even of er foutjes in de pagina staan. Vergeet echter niet om ook te checken of de links in de pagina naar de juiste plek leiden, zowel binnen als buiten de wiki. Een relatie van deze standaard naar een andere standaard moet ook op die pagina zichtbaar zijn als afgeleide relatie. En de standaard moet in de juiste overzichten terecht komen, dus niet alleen in de lijst met standaarden maar ook in de juiste Views zoals die van gerelateerde Domeinen, en lagen van het Vijflaagsmodel. En op je eigen pagina met standaarden van je (sub-)thema. Zo nee, dan is er waarschijnlijk iets mis gegaan met de invoer van die eigenschappen - of er is iets mis met de query in het overzicht.

Persoonlijke instellingen
Naamruimten

Varianten
Handelingen
Hulpmiddelen