Amélioration de la section SGB

profcfuhrmanets / log210-enonce-lab1

Énonce pour le travail en équipe de laboratoire du cours LOG210 à l'École de technologie supérieure

MIT License

5 stars 68 forks source link

Amélioration de la section SGB #91

Open Olon11 opened 4 months ago

Olon11 commented 4 months ago

Le SGB a évolué et la section SGB de l'énoncé n'est plus à jour. Notamment :

[ ] On ne devrait pas avoir le MDD du SGB dans l'énoncé. On doit plutôt faire référence au MDD dans le README du SGB.
[x] « Il possède une interface de configuration permettant de nettoyer le contenu correspondant aux notes ». Il n'y a aucune route du genre. Soit on en ajoute une, soit on retire cette phrase.
[x] « L'API de SGB est disponible avec le code source. Lisez le README.md de SGB pour savoir comment générer cette documentation. ». Vrai, mais on peut aussi consulter la documentation directement en ligne. Je modifierais la phrase pour être plus générique et dire qu'on explique comment consulter la documentation dans le dépôt.

fuhrmanator commented 4 months ago

On ne devrait pas avoir le MDD du SGB dans l'énoncé. On doit plutôt faire référence au MDD dans le README du SGB.

L'avantage d'avoir le MDD dans l'énoncé est que c'est concis. Je ne veux pas que SGB (et son code) soit à étudier profondément. SGB est censé être une boîte noire (système externe).

OK pour les deux autres points.

Olon11 commented 4 months ago

Dans ce cas, on peut mettre le lien vers le MDD du SGB dans l'énoncé plutôt que de dupliquer le fichier.

Olon11 commented 4 months ago

Si l'image dans l'énoncé pointe vers le MDD dans le dépôt du SGB, on perd la partie SGA, mais on s'assure que le MDD est toujours à jour. À mon avis, la partie SGA n'apporte pas grande chose, donc ce n'est pas grave de l'enlever. Qu'est-ce que tu préfères?

fuhrmanator commented 4 months ago

Je préfère que tout soit dans SGA, y compris le MDD de SGB. Ce MDD décrit le problème que SGB résout (en partie). SGB doit être cohérent avec ça et pas dans l'autre sens.

Olon11 commented 4 months ago

Je préfère que tout soit dans SGA

Oui, j'avais compris cette partie. Je voulais savoir comment tu préférais procéder pour accomplir ça :

Le MDD du SGB est dans le dépôt du SGB. On met un lien vers ce MDD dans l'énoncé. On n'a plus la partie SGA dans le MDD.
Même chose que 1, mais on ajoute la partie SGA au MDD du SGB.
On met le MDD du SGB dans le dépôt de l'énoncé. On met un lien vers ce MDD dans le dépôt du SGB.

fuhrmanator commented 4 months ago

L'option 3 me va.