Mensen geven alle dingen een naam. Dingen een naam geven is een manier om orde in de wereld aan te brengen. Het helpt andere mensen ook om te weten waar je naar verwijst. In de wetenschap wordt de classificatie van soorten een taxonomie genoemd.
In elk softwareontwikkelingsproject is het geven van een goede naam ook van cruciaal belang, om veel van dezelfde redenen. Belast uw taxonomie niet en maak gebruik van onze ervaring.
Bij OpenC gebruiken we een consistent en gedocumenteerd systeem voor het benoemen van dingen in Studio (en in de rest van het Claris-platform). Hier volgt een samenvatting van de vuistregels die we toepassen:
Edit (10 jun. 2025): Bedankt voor alle goede feedback waarmee we deze richtlijnen konden verbeteren! U vindt de nieuwe versie hieronder.
Studio naam - maak het kort en scherp, bijv: OpenC DEV
Belangrijk als je meerdere Claris Studio's moet beheren en ontwikkelen en ertussen moet schakelen.
Gebruikersnamen - neem de naam van de afdeling of organisatie op, bijv: Remco van Buren van OpenC
Op het moment van schrijven is er geen beschrijvingsveld voor de gebruiker. Dus nemen we de naam van de organisatie op in de Gebruikersnaam. We voegen ook het woord 'van' toe omdat we die accountnaam soms gebruiken in een View, zoals dit: 'Hoi Remco van Buren van OpenC!' Dat is logischer dan iets als 'Hoi OpenC | Remco van Buren!'
Namen van groepen - inclusief de rol, bijv: OurClient, Users
In Claris Studio is er op het moment van schrijven geen beschrijvingsveld voor een Groep. Daarom zetten we een beschrijving van de gebruikersrol in het veld Groepsnaam.
Hubnamen - houd de gebruiker in gedachten, bijv: Uw klanten
Als de gebruiker lidmaatschapsrechten heeft en in Studio inlogt, dan moet het meteen duidelijk zijn wat de Hubs waartoe hij toegang heeft, voor hem betekenen. Voorbeelden van hubnamen: 'Sales funnel' of 'Project AI'.
Weergavenamen - kort en betekenisvol voor de gebruiker, bijv: Uw klantenformulier
De tegel van een weergave geeft aan wat voor soort weergave het is. Een Spreadsheet View is bijvoorbeeld een groene tile met een tabel-icoon erin. Een Form View is een middenblauwe tile met een form-icoon erin. Toch zetten we bij OpenC de naam van het View-type in de beschrijving, aan het einde, zonder het woord 'View'. Enkele voorbeelden:
Opdrachtgever-sheet(Sheet als een korter woord voor Spreadsheet View).Klanten-formulier(voor Formulierweergave).Klanten-CV(voor Custom View).Klanten-media(voor galerijweergave).
Frame – deze functionaliteit moet nog komen, we zullen onze richtlijnen op een later moment toevoegen
Tabelnamen - Begin met een hoofdletter en in het meervoud, bijv: Klanten
Wanneer een tabel wordt gemaakt in Studio, krijgt deze een standaardnaam zoals Spreadsheet16. Wijzig deze naam, anders wordt het later moeilijk om de juiste tabel te selecteren, in berekeningen in Studio of in Claris Connect flowstappen.
Veldnamen - pas de snake_case methode, bijv: client_name
Deze wereld zit vol met allerlei conventies om dingen een naam te geven: Hoofdletters met spaties, kleine letters zonder spaties, camelCasePascalCase, snake_caseen, grappig genoeg, SCREAMING_SNAKE_CASE. Bij OpenC hebben we besloten om de kleine letters snake_case te gebruiken. Deze methode heeft verschillende voordelen:
- Het simpelweg weglaten van de spaties kan leiden tot dubbelzinnigheid. Neem
itscrapals voorbeeld: was het "IT scrap" of "it's crap"? - Zelfs als het gebruik van
kleine lettersniet dubbelzinnig zou zijn, issnake_caseduidelijker, vooral voor mensen wiens moedertaal niet Engels is.snake_caseis de enige methode die echt laat zien waar de spaties stonden. - Aangezien we geen spaties gebruiken in veldnamen, hoeven we geen aanhalingstekens te gebruiken in Studio-berekeningen. Vergelijk
tasks.due_date.valuemetTasks."Due Date".value. - Het verbetert ook de leesbaarheid in Claris Connect: vergelijk
Fields.email_address.ValuemetFields.[Your e-mail address].Value.
Je wijst er terecht op dat PascalCase en snake_case zich ongeveer hetzelfde gedragen als het gaat om aangeven waar spaties stonden, maar wij geven de voorkeur aan snake_case. Naar onze mening laat PascalCase nog steeds te veel keuze over voor de ontwikkelaar: "moet ik JSONField of JsonField schrijven?". De kans is groot dat we met beide varianten uitkomen, en dan zou onze conventie het doel missen - terwijl het afdwingen van de snake_case conventie ertoe zou leiden dat iedereen json_field zou schrijven, ongeacht persoonlijke voorkeur.
Objectnamen op Views - Zet de veldnaam en het objecttype in de Objectnaam, bijv: client_full_name_shorttext
Geef het Object altijd een juiste naam. We nemen de veldnaam op, dan een underscore en dan het objecttype. Ander voorbeeld: client_list of client_sheet.
Labels en placeholders weergeven – wees duidelijk voor de gebruiker
Het displaylabel vertelt de gebruiker wat hij moet invoeren. Het moet duidelijk zijn, zodat de gebruiker weet wat hij moet invoeren.
De placeholder kan de gebruiker verder helpen: het kan een instructie bevatten zoals 'Voer je naam in' of het kan een voorbeeld geven.
Als het geen toegevoegde waarde heeft voor de gebruiker, laten we de placeholder leeg. De gebruiker hoeft dan minder tekst te lezen en het scherm ziet er schoner uit.
Als bonus zijn hier nog twee richtlijnen die we bij OpenC toepassen:
- In Studio gebruiken we alleen getalvelden als we een veld nodig hebben voor numerieke berekeningen, zoals optellen of delen. Als we een veld nodig hebben voor een statuscode, zoals
0,1of2, gebruiken we nooit een getalveld, omdat deze codes geen rekenkundige waarden zijn. Daarom gebruiken we hiervoor een kort tekstveld. - Houd er rekening mee dat veldnamen en ook veldbeschrijvingen niet op het scherm kunnen worden gelabeld in bepaalde objecten, zoals een Spreadsheetobject. Deze objecten tonen de veldnaam en beschrijving, bijvoorbeeld
Client_name. Als dat een probleem is voor je gebruikers, moet je het veld hernoemen naar bijvoorbeeldKlantnaam.
Wilt u meer weten?
Download de OpenC richtlijnen hier. Dit document bevat enkele schermafbeeldingen en iets meer details ter verduidelijking. Pas de OpenC-richtlijnen voor naamgevingsconventies toe op Claris Studio of pas ze aan uw behoeften en die van uw klanten aan.