Utilisation des champs description
Dans certains outils de programmation visuelle qui vous permettent de créer des bases de données, il est possible d’avoir des champs permettant de décrire (sujet de la base de données, une formule…).
INFO
Cette partie est optionnelle, mais conseillée si les outils de bases de données vous le propose afin de vous permettre de documenter vos projets plus facilement sans avoir à passer par un document externe.
MÉTHODOLOGIE
Voici comment vous pouvez gérer avec PredicTable ces descriptions.
| MÉTHODOLOGIE | DESCRIPTIF |
|---|---|
| Utiliser le format markdown | Utiliser les symboles du markdown en guise de séparateur : # ## ### Les titres sont notés en majuscule. Les paragraphes explicatifs en minuscule. |
| Utiliser l’anglais | L’anglais vous permettra d’être international et de faire comprendre le but de votre base de données à vos équipes quelle que soient leur nationalité. Toutefois, si le projet est à destination unique d’une équipe non-international, vous pouvez préférer utiliser la langue natale de votre client / équipe. Sur ce point soyez pragmatique, mais cohérent tout le long du projet. |
| Avoir un plan clair permettant de décrire au mieux. | Vous devez répondre à ces questions quand vous écrivez une description : - À quoi ça sert ? Contexte, problématique, Description. - Qui a réalisé cela ? Cela va vous aider sur la maintenance pour demander un support en cas de question. Le mieux est de mettre directement son email. En optionnel, vous pouvez mettre des liens vers des ressources qui vous ont aidé ainsi que les dépendances de ces données. Soyez pragmatique. Si vous devez décrire un élément cela doit se faire au mieux et au plus précis afin de pouvoir faciliter la maintenance. |
INFO
Ce n’est pas parce qu’un champ pour décrire un élément existe qu’il faut forcément l’utiliser. Certains éléments sont évidents et ne nécessitent pas de description. Une description doit être là pour aider et non remplir un champ !
Pour savoir si vous devez écrire une description ou non, posez-vous la question de savoir si vous avez des difficulté sur la construction de tel ou tel objet. Si cela n’a pas été évident, décrivez-le.
DES EXEMPLES
TIP
Context
Doit répondre à la question “Pourquoi ?” Pourquoi tel élément s’appelle comme cela ? Pourquoi est-il ici et pas ailleurs ? >
Decription
Doit répondre à la question au-dessus et expliqué le choix fait.
Leader
john@johncrew.co, jane@johncrew.co,