Décrire littérairement un schéma

Décrire littérairement un schéma

Décrire littérairement un schéma dans un cahier des charges

Décrire littérairement un schéma
Photo by Christina @ wocintechchat.com on Unsplash

Qu’est-ce que décrire littérairement un schéma ?

Lorsqu’on rédige un cahier des charges, décrire littérairement les schémas de façon bidirectionnelle signifie que l’on puisse faire le lien dans les deux sens entre un schéma et la description textuelle qui l’accompagne : depuis le schéma, on peut retrouver facilement la portion de texte qui l’explicite et, inversement, depuis le texte on peut directement faire le lien avec les éléments concernés du schéma.

Ainsi, la bidirectionnalité peut se faire de deux façons (non excluantes) en :

  • Veillant à ce que les termes employés dans le schéma et le texte soient concordants.
  • Utilisant des puces numérotées permettant de faire le lien entre le texte et le schéma.

Bien entendu, cela demande une grande rigueur mais aucune technicité particulière.

Utilité de décrire littérairement et de façon bidirectionnelle un schéma dans un cahier des charges

Partage de la connaissance

Partage de la connaissance
Photo by Hannah Busing on Unsplash

A présent que le terme de “bidirectionnalité” est défini, et avant de voir en quoi elle est précieuse, il s’agit déjà de rappeler que les cahiers des charges que nous produisons sont amenés à être lus par des personnes aux profils et aux parcours extrêmement variés, comme nous l’évoquions dans l’article Cahier des charges : définition difficile du métier.

Par conséquent, nombreux seront ceux qui ne possèdent pas les clés pour lire les schémas mais qui ont pourtant besoin de les comprendre pour valider sereinement le cahier des charges.

C’est là que la description littéraire entre en jeu : elle permet à chacun d’acquérir exactement le même niveau de connaissance et de compréhension du cahier des charges, et ce indépendamment du fait que le lecteur soit familier ou non avec la “langue” du schéma, UML par exemple.

  • Cela facilite grandement les choses au moment de valider le livrable car on ne valide bien que ce que l’on comprend bien.
  • Cela évite de démotiver le lecteur en le confrontant à des choses qu’il ne comprend pas et qu’on ne lui explique pas.

Dit autrement :

La description littéraire est un acte pédagogique.

Renfort de la cohérence

Renforcer la cohérence
Photo by Maria Teneva on Unsplash

Si l’on dessine des schémas ou que l’on est amené à fabriquer des maquettes d’écrans, alors le fait d’utiliser strictement les mêmes termes dans les parties graphiques et textuelles contribue à renforcer la cohérence du cahier des charges.

En effet, cela permet de ne générer aucune ambiguïté, aucun “flou”, et donc de faciliter la compréhension du lecteur.

Au sujet des flous, pour vous distraire un instant, vous pouvez visionner cette brève chronique de Marina Rollman sur France Inter : https://www.youtube.com/watch?v=kUfMnx-8PGs&t=86s&ab_channel=FranceInter

Mais reprenons notre propos concernant les ambiguïtés de langage. Si, par exemple, un schéma présente le concept métier de « bénéficiaire » et que sa description textuelle (c’est déjà bien qu’il y en ait une) parle d’un « ayant-droit », le lecteur sera perdu :

  • Puisqu’il ne retrouve pas dans le schéma ce qu’il vient de lire, est-ce que cela signifie que le schéma est incomplet ou que le texte évoque des éléments hors périmètre ?
  • Quel est le bon terme métier à employer ? Bénéficiaire ou ayant-droit ?
  • Est-ce que ce sont les mêmes concepts ? Le synonyme est l’ennemi juré de la clarté.

Par conséquent, être totalement bidirectionnel demande donc au rédacteur la plus grande rigueur. En effet, cela implique d’être vigilant à chaque mise à jour du schéma et, par conséquent, du texte accompagnant.

Exemples de description littéraire bidirectionnelle d’un schéma dans un cahier des charges

Les schémas “non normés”

Les schémas non normés
Photo by Yann Allegre on Unsplash

Tout d’abord, que les plus novices soient rassurés. Si vous n’êtes pas familiers des schémas “traditionnels” présents dans les cahiers des charges, sachez que tout schéma est à prendre dès lors qu’il apporte de la clarté, permet de synthétiser les choses.

Ainsi, il vaudra toujours mieux insérer un schéma de votre cru plutôt qu’aucun. En revanche, plus le schéma sera issu de votre imagination graphique, plus il sera nécessaire de l’accompagner d’une description textuelle.

En effet, si dans l’immédiat vous serez présent pour l’expliquer aux différents lecteurs, il ne faut pas perdre de vue qu’un cahier des charges est souvent rédiger pour durer, c’est un document auquel on est amené à régulièrement se référer. Or si dans six mois, dans 3 ans, plus personne n’est en mesure de comprendre le schéma, votre travail aura été vain. D’où l’importance de le décrire : pour qu’il reste compréhensible.

C’est là l’écueil d’un schéma “non normé” par rapport à un schéma “normé” : comme sa syntaxe est propre à son auteur, il n’est rapidement plus compréhensible.

Les schémas normés

Les schémas normés
Photo by Louis Mornaud on Unsplash

Dans les chapitres qui suivent, l’objectif n’est pas de vous apprendre à faire les schémas mais plutôt de vous aguiller sur une façon simple de les décrire textuellement.

Le diagramme de classe

Dans un diagramme de classe, la bidirectionnalité signifie que tous les éléments graphiques du schéma sont repris à l’identique dans la description textuelle. C’est-à-dire que le nom des classes, les libellés des attributs, les verbes d’association et les multiplicités minimum et maximum devront être transcrits à l’identique, sans distorsion ni omission.

Il existe un niveau plus avancé de description de ce schéma qui consiste à n’expliciter que les liens et les multiplicités les plus structurants mais, dans un premier temps, l’approche la plus simple est de tout décrire. Si vous souhaitez en apprendre d’avantage sur la méthode “avancée”, n’hésitez pas à me contacter !

Schéma
Description d'un diagramme de classe
Exemple de description littéraire bidirectionnelle dans un diagramme de classe
Description littéraire bidirectionnelle du schéma

Un Membre est une personne physique inscrite sur le site et qui se caractérise par :

  • un pseudo, par exemple « Interpolian »,
  • un email,
  • une date de naissance.

Un Forum est un sujet de discussion, par exemple « Les émissions de radio dans les années 90 », qui se définit par :

  • un titre,
  • une date de publication.

Un Forum est créé par un seul Membre et un Membre peut créer aucun ou plusieurs Forums.

Un membre n’est pas obligé de créer un forum, il peut se contenter de consulter des forums existants. Par exemple, Interpolian n’a créé aucun forum là où Nico_Tag en a créé onze.

Un Message est une réponse apportée par un Membre sur un Forum. Il se caractérise par :

  • un texte,
  • une date de publication.

Un Message est posté sur un Forum et un Forum contient aucun ou plusieurs Messages.

En effet, lorsqu’un forum est créé, aucun membre n’y a encore posté de messages.

Un Message est écrit par un Membre et un Membre écrit aucun ou plusieurs Messages.

Il n’est pas obligatoire de rédiger des messages pour être membre.

Le diagramme d’état

Description littéraire bidirectionnelle d'un diagramme d'état
Description littéraire bidirectionnelle d’un diagramme d’état

Dans le cas d’un diagramme d’état, si l’on puce (numérote) les états et que l’on reprend  dans la description textuelle exactement les mêmes libellés que sur le schéma alors cela assure la bidirectionnalité.

Par exemple :

  • « Pour que l’objet étudié passe de l’état source (1) à l’état cible, l’événement [condition] / activité doit avoir lieu. »
  • « Si l’événement [condition] / activité a lieu, alors l’objet étudié passe de l’état source (1) à l’état cible. »
  • « Si l’objet étudié est à l’état source (1) et que l’événement [condition] / activité a lieu alors il passe à l’état cible (2). »

Le diagramme de flux

Description littéraire bidirectionnelle d'un diagramme de flux
Description littéraire bidirectionnelle d’un diagramme de flux

Dans le cas d’un diagramme de flux, si l’on puce (numérote) les flux et que l’on reprend  dans la description textuelle exactement les mêmes libellés que sur le schéma alors cela assure la bidirectionnalité.

Par exemple : « Un client passe commande (1) auprès d’un fournisseur et ce dernier assure la livraison (2). »

Le diagramme d’activité

Décrire littérairement un diagramme d'activité
Description littéraire bidirectionnelle d’un diagramme d’activité https://laurent-audibert.developpez.com/Cours-UML/?page=diagramme-activites

Dans le cas d’un diagramme d’activité, si l’on puce (numérote) les actions et que l’on reprend  dans la description textuelle exactement les mêmes libellés que sur le schéma alors cela assure la bidirectionnalité.

Par exemple : « Le DAB demande d’abord d’insérer la carte (1) puis de saisir son code (2). Si le code est valide, l’utilisateur doit choisir l’opération (3) qu’il souhaite effectuer. S’il sélectionne le dépôt, alors le DAB propose de saisir le montant (4) à déposer, puis de choisir le compte (5) à créditer et d’insérer l’enveloppe (6). Une fois cela fait, le DAB doit restituer la carte (7). Etc. »

Les écrans

Décrire littérairement un écran
Description littéraire bidirectionnelle d’un écran

Dans la spécification d’un écran, la bidirectionnalité passe d’abord par le fait de pucer (numéroter) chaque élément qui fera l’objet d’une description. Ensuite, les puces sont reprises dans les exigences à chaque fois qu’un élément de l’écran est mentionné.

► M1/L’écran d’inscription « Insc_01 » doit présenter les informations suivantes :
– nom/pseudo (1),
– email (2),
– confirmation de l’email (3),
– pays (4),
– ville (5),
– âge (6),
– site internet (7),
– un bouton d’enregistrement (a). [00001]

Vous remarquerez que l’écran est légendé, qu’une référence unique lui est attribuée et que cette référence est reprise dans l’exigence.

► M1.1/Le nom/pseudo (1), l’email (2) et la confirmation de l’email (3) doivent être obligatoires. [00002]

► M1.2/Le Nom/pseudo (1) doit être un champ de type alphanumérique avec acceptation des caractères spéciaux et limité à 35 caractères. [00003]

Etc.

En espérant que ces conseils vous seront profitables, n’hésitez pas à nous répondre en commentaire ou à vous abonner à notre newsletter en bas de cette article. Venez partager votre expérience en commentaire sur les sujets en lien avec les cahier des charges !

Partager l'article:
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  
  •  

Laisser un commentaire

Votre adresse e-mail ne sera pas publiée. Les champs obligatoires sont indiqués avec *