search

profcfuhrmanets / log210-systeme-gestion-bordereau-node-express-ts

Système de gestion des bordereaux (SGB) utilisé dans le cadre du cours de LOG210.
https://profcfuhrmanets.github.io/log210-systeme-gestion-bordereau-node-express-ts/
0 stars 17 forks source link

Le diagramme de classes n'est pas utile #10

Open Olon11 opened 2 months ago

Olon11 commented 2 months ago

Je ne vois pas l'intérêt d'avoir un diagramme de classes dans le README.md. On ne devrait pas demander aux étudiants d'aller dans le code pour voir comment ça fonctionne. Ça devrait être suffisant de lire la documentation de l'API pour comprendre comment utiliser le SGB.

Ce qu'on devrait plutôt montrer dans le README.md, c'est le modèle du domaine.

fuhrmanator commented 2 months ago

Je suis d'accord que le MDD devrait y être.

En passant, tplant a des bogues (régressions) en ce moment https://github.com/bafolts/tplant/issues/122#issuecomment-2133706235

Olon11 commented 2 months ago

J'ai remplacé le diagramme de classes par le MDD dans 3d22631, mais j'ai gardé les commandes pour générer le diagramme de classes. Est-ce que je devrais les enlever? (Je le ferais)

fuhrmanator commented 2 months ago

j'ai gardé les commandes pour générer le diagramme de classes. Est-ce que je devrais les enlever? (Je le ferais)

Le diagramme généré par tplant pourrait être utile pour comprendre la bonne structure qui suit la méthodologie. Par exemple, il devrait y avoir une bonne correspondance entre les classes conceptuelles et les classes logicielles dans src/model.

Olon11 commented 2 months ago

Bonne idée. Je pourrais ajouter un texte à ce propos dans la documentation

fuhrmanator commented 2 months ago

Dépend de #9 je crois