Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Le diagramme de classes n'est pas utile #10

Open
Olon11 opened this issue May 29, 2024 · 5 comments
Open

Le diagramme de classes n'est pas utile #10

Olon11 opened this issue May 29, 2024 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Olon11
Copy link
Contributor

Olon11 commented May 29, 2024

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.

@Olon11 Olon11 self-assigned this May 29, 2024
@Olon11 Olon11 added the documentation Improvements or additions to documentation label May 29, 2024
@fuhrmanator
Copy link
Contributor

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

En passant, tplant a des bogues (régressions) en ce moment bafolts/tplant#122 (comment)

@Olon11
Copy link
Contributor Author

Olon11 commented May 31, 2024

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
Copy link
Contributor

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
Copy link
Contributor Author

Olon11 commented Jun 10, 2024

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

@fuhrmanator
Copy link
Contributor

Dépend de #9 je crois

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants