Pourquoi une convention de nommage ?

Contrairement à la programmation dite scripturale, l’écosystème des outils de programmation visuelle est en pleine construction sur la question des standards. Alors que dans le premier cas, on retrouve bon nombre de méthodologies aussi bien pour du frontend et du backend, force est de constater que dans le second cas il y a un manque criant de méthodologies pour aider les Product Builders à créer des applications de qualité de manière consistante.

Il existe bien en entreprise quelques Product Builders qui s’organisent de manière à avoir des méthodologies en internes, mais ces dernières ne sont pas partagées à l’écosystème. Souvent par manque de temps pour poser la méthodologie et la maintenir par la suite.

L’ambition d’une méthodologie doit être mesurée. Elle doit à la fois donner des lignes directrices claires, elle doit savoir trancher des situations, mais en même temps elle doit être pensée de manière flexible afin de pouvoir englober un maximum de situation.

Dans l’écosystème des Product Builder et de la programmation visuelle, force est de constater que la question du nommage est un véritable sujet sur lequel il y a une véritable inconsistance dans un très grand nombre de projets. Techniquement, la plupart fonctionnent, mais il est très difficile d’y voir clair lorsque la base de données grandit et encore plus complexe de travailler à plusieurs si chacun à sa propre méthodologie.

PredicTable vise à résoudre ce problème.

PredicTable est la première méthodologie de nommage dédiée aux outils de programmation visuelle de bases de données.

Objectif de la méthodologie PredictTable

L’objectif de la méthodologie est triple :

1. Vous permettre de nommer clairement et de manière consistante tous les éléments de vos bases de données ;
2. Vous permettre de documenter vos bases de données afin de les faire évoluer plus facilement ;
3. Vous permettre de travailler à plusieurs avec une méthodologie commune.

Pourquoi est-il si important de bien nommer ses éléments dans une base de données ?

Nommer un élément, c’est lui donner vie pour longtemps

Lorsque vous allez nommer un élément dans une base de données, vous allez lui donner une structure qui va rester dans le schéma globale de la base de données et dans lequel il va avoir une place toute particulière et qui vous permettra à vous et à toute votre équipe de l’identifier.

Nommer ces éléments, en respectant une structure, c’est donner vie à son projet. En structurant ce nommage autour d’une convention, l’objectif est de fournir des nommages cohérents qui vont durer dans le temps pour donner vie à ce projet de manière harmonieuse.

Les noms sont un contrat

Lorsque vous devez nommer plusieurs éléments dans une base de données, il faut :

• Qu’ils soient lisibles ;
• Qu’ils soient compréhensibles ;
• Qu’ils soient structurés d’une manière identifiable ;
• Qu’ils soient capables de durer dans le temps.

Pour toutes des raisons, il faut voir le nommage des différents éléments d’une base de données comme une convention, un engagement que vous allez prendre avec vous-même et/ou votre équipe afin de garantir les bonnes relations et d’être bien certain que vous parlez bien de la même chose.

Il faut donc voir une convention de nommage telle que PredicTable comme un contrat qui vous lie sur la durée afin de garantir un ensemble de relations et de compréhension des objets dans une base de données.

Bien nommer permet de gagner en efficacité sur la durée

Nommer vos éléments dans vos bases de données va vous permettre de gagner en efficacité :

• À la fois dans votre développement puisque vous allez pouvoir nommer plus rapidement vos objets sans avoir à réfléchir à leur structure de nommage ;
• À la fois dans le partage de votre travail en équipe puisque chacun va être capable de prendre en main plus facilement le projet ;
• À la fois en maintenabilité puisque vous vous pourrez plus facilement maintenir un projet si vous le comprenez plus vite.

Les règles de la méthodologie PredicTable

Lors de l’élaboration de cette méthodologie, nous avons souhaité mettre en place 4 règles :

1. Être consistant dans la rédaction

Savoir comment nommer les éléments (table, attributs, vues…) d’une base de données n’est pas évident. Il faut :

• Trouver le bon nommage qui décrit bien ce qui est représenté ;
• Faire des choix de nommage dont les termes ne rentrent pas en contradiction technique avec d’autres outils utilisés ;
• Quand vous avez déterminé les bons nommages qui vous conviennent, il faut ensuite s’y tenir tout au long de la vie du projet pour le faire évoluer sereinement.

Le principe de PredicTable est de vous permettre de faire ces choix régulièrement afin que le nommage de vos éléments soit toujours le même tout au long de votre projet.

2. Être le plus clair possible pour assurer la meilleure lisibilité

Lorsque vous travaillez sur un projet de bases de données, bien nommer sur tous ses éléments est primordial pour au moins 2 cas :

1. Bien nommer va permettre à votre “futur vous” de garder une bonne compréhension du projet et d’être capable de vous replonger dedans même quelques semaines après.
2. Bien nommer va vous permettre de travailler plus efficacement et sereinement en équipe puisque vous allez pouvoir baser vos développements sur une méthodologie commune.

Ainsi l’objectif de PredicTable est de vous construire un guide sur lequel vous allez pouvoir vous reposer pour nommer les différents éléments d’une base de données afin que cela soit le plus lisible pour vous et vos équipes.

3. Partager la méthodologie et la documentation associée

PredicTable a été pensé dès le départ comme une méthodologie qui devait bénéficier au plus grand nombre.

Elle est gratuite et le restera.

L’objectif est de la faire évoluer en fonction des besoins de la communauté et qu’elle permette au plus de monde possible de construire des projets de qualité avec des standards élevés.

Il est à noter toutefois que la méthodologie PredicTable ne vous exempte pas d’une documentation associée. Le nommage de tous les éléments participe bien évidemment à faciliter la compréhension de votre base de données, mais elle vient ici plutôt faciliter la construction de votre documentation.

4. Garder une certaine flexibilité

La difficulté dans la création d’une méthodologie est double :

1. Elle doit être la plus exhaustive et précise possible pour aider à la compréhension et ne pas être bloqué ;
2. Et en même temps, elle se doit d’être flexible étant donné qu’il y aura toujours des cas d’usages non-prévus et qui méritent d’être pragmatiques.

C’est donc un jeu d’équilibriste qui doit être joué entre l’ambition qu’on souhaite lui donner et une vision qui doit se vouloir pragmatique afin de coller aux plus près des projets des Product Builders.

Bien évidemment, la méthodologie PredicTable va évoluer pour tenir compte de tous ces éléments. Elle doit être un guide pour vous et vos équipes, mais à vous de chercher constamment ce qui fera le plus sens pour vos projets.

Utilisation de la méthodologie PredicTable

Comment lire la méthodologie ?

Pour démarrer avec PredictTable, il est recommandé de lire a minima, tout le chapitre concept. Ce chapitre englobe tout ce que vous devez savoir sur le nommage de vos éléments sur une base de données en programmation visuelle.

Pour bien saisir la méthodologie, nous vous conseillons de regarder les différents exemples proposés. Si vous pouvez mettre en pratique en même temps cette méthodologie sur un projet, cela sera encore plus facile à prendre en main.

Si vous avez des difficultés, vous pouvez vous rendre sur le Discord associé pour poser vos questions sur les différents channels associés.

Comment faire référence à PredictTable sur votre site ?

Si vous utilisez PredicTable et que vous souhaitez mettre en avant la méthodologie et la citer, nous vous demandons de faire un lien vers le site http://www.predictframework.com.