Richtlijnen voor naamconventies
In de Regelbeheer applicatie is men vrij om de onderdelen een naam naar keuze te geven. Erg handig, al die vrijheid maar dit kan er ook voor zorgen dat uiteenlopende naamgeving de applicatie wat onoverzichtelijk maakt. Het is aan te raden hier een bepaalde consistentie in aan te houden omdat anderen hierdoor gemakkelijker de bedachte structuur kunnen doorgronden. In dit artikel zullen een aantal voorbeelden en adviezen worden gegeven omtrent afspraken die kunnen worden gemaakt rondom deze naamconventies.
Snel naar:
Naam v.s. titel
Hetgeen wat men in het invoerveld ‘naam’ invult is altijd een naam die intern wordt gebruikt. Bij het invoerveld ‘titel’ wordt een naam opgegeven die ook wordt doorgeleverd naar het DSO. Dit is dus een naam die in het DSO zichtbaar zal zijn voor initiatiefnemers. Juridische teksten bevatten een invoerveld voor een naam en titel. Wanneer de juridische teksten worden doorgeleverd aan het DSO is het verplicht om de juridische teksten van een titel te voorzien. Behalve voor juridische teksten met het type ‘lid’, hiervoor is de titel optioneel.
Maak eenduidige verkortingen
Hou er rekening mee dat namen/id’s van gebruikersvragen, (toepasbare) regels, locaties maar een beperkte lengte kunnen hebben. Een eenduidige verkorting van woorden maakt het lezen en vinden van de juiste naam gemakkelijker en versnelt het werken met de applicatie.
Voorbeelden van inhoudelijke conventies/afspraken zijn
- Wees expliciet
- Vermijd negatieve vragen (of dubbele ontkenningen)
- Eindig een gebruikersvraag altijd met een vraagteken
- Hanteer dezelfde trefwoorden in een gebruikersvraag als in de (toepasbare) regel waar de gebruikersvraag in wordt gebruikt
- Spreek af om geen verwijzingen naar onduidelijke begrippen te maken. (Bijvoorbeeld: datum inwerkingtreding BARRO (Besluit algemene regels voor de ruimtelijke ordening). Schrijf 30 december 2011)
- Spreek af of de uitkomst van een (toepasbare) regel (ja of nee) een extra betekenis krijgt en deze wordt verwerkt in de naam. Bijvoorbeeld het schrijven de uitkomst in de naam van de (toepasbare) regel wanneer de regel voor 1 regel is opgesteld zoals: WV Beplanting – TR verwijderen – MP
Mogelijke afkortingen
| Naam | Afkorting | Gebruik |
| Hoofdstuk | H | Bij naam onder interne documentatie |
| Afdeling | Afd | Bij naam onder interne documentatie |
| Paragraaf | Par | Bij naam onder interne documentatie |
| Subparagraaf | Subpar | Bij naam onder interne documentatie |
| Art | artikel | Bij naam onder interne documentatie |
| Lid | Lid | Bij naam onder interne documentatie |
| Kabels en leidingen | K&L | |
| Gebruikersvragen | GV | Voor (toepasbare) regels die gebruikersvragen gebruiken |
| (toepasbare) Regels | TR | Voor (toepasbare) regels die gebaseerd zijn op andere (toepasbare) regels |
| Locatie | Loc | Voor (toepasbare) regels die locaties gebruiken |
| Vergunningsplicht | VP | Voor de conclusie ‘Vergunningsplicht’ |
| Meldingsplicht | MP | voor de conclusie ‘Meldingsplicht’ |
| Informatieplicht | IP | voor de conclusie ‘Informatieplicht’ |
| Toestemmingsvrij | TV | voor de conclusie ‘Toestemmingsvrij’ |
| Neem contact op met het loket | Loket | voor de conclusie ‘Neem contract op met het loket’ |
| Niet van toepassing | NVT | voor de conclusie ‘Niet van toepassing’ |
| Verbod | Verbod | voor de conclusie ‘Verbod’ |
| Algemene regel | AR | voor ‘Algemene Regel’ |
| Zorgplicht | ZP | Voor ‘Zorgplicht’ * |
*Zorgplicht wordt door het DSO niet erkent als officiële uitkomst. Indien er sprake is van zorgplicht kan dit worden opgenomen in de begeleidende tekst bij de uitkomst ‘toestemmingsvrij’
Tekstuele afspraken
- Spreek af of gesproken wordt over vergunningplicht of vergunningplichtig
- Spreek af of GV, TR, Loc, AR, ZP, TV, VP, MP, IP, NVT, BG en andere verkortingen met een hoofdletter worden geschreven.
- Spreek af of een (toepasbare) regel begint met de activiteit (of een verkorting daarvan)
- Spreek af of er verbindingstekens worden gebruikt en op welke posities
- Spreek af welke speciale karakters mogen worden gebruikt (en zo ja, in welke situaties)
- Spreek af of er haakjes mogen worden gebruikt (en zo ja, in welke situaties)
- Spreek af of een activiteit altijd met een werkwoord begint of eindigt
- Spreek af of een werkzaamheid altijd met een werkwoord eindigt of begint
- Spreek de naamopbouw van locaties af vanwege de oplopende alfabetische sortering in Regelbeheer. (Bijvoorbeeld: Waterkering primair, waterkering regionaal, primaire waterkering, regionale waterkering
- Spreek af of namen/identificaties moeten eindigen met een punt
- Wees alert op het gebruik van puntkomma’s in tekst/opsommingen. Niet alle lezers begrijpen de betekenis van de puntkomma. Dit kan leiden tot misinterpretatie van de tekst/opsomming. Spreek af of ‘puntkomma’ vervangen moet worden door het woord ‘en’