-
Notifications
You must be signed in to change notification settings - Fork 2
/
Outils-UML.qmd
81 lines (58 loc) · 6.51 KB
/
Outils-UML.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# Outils pour la modélisation UML
Le chapitre F20/A22\ {{< fa solid book >}}\ définit quelques termes importants pour la modélisation avec l'UML et les outils utiles.
En mode esquisse, lorsqu'on dessine un modèle sur un tableau blanc ou sur papier, un outil pratique pour numériser le tout est **Microsoft Lens** ([Android](https://play.google.com/store/apps/details?id=com.microsoft.office.officelens&hl=fr_CA) ou [iOS](https://apps.apple.com/ca/app/microsoft-office-lens-pdf-scan/id975925059)).
Les filtres pour supprimer les reflets sur les tableaux blancs sont impeccables.
::: {#fig-OfficeLens layout-ncol=2 layout-valign="bottom"}
{#fig-beforeLens width="300px"}
{#fig-afterLens width="300px"}
Microsoft Lens peut détecter le cadre d'un dessin sur un tableau blanc ou sur papier et le transformer, même si l'on n'est pas droit devant le dessin.
:::
::: {.callout-caution}
Tous les travaux demandés pour les **examens** (de _LOG210_ à l'École de technologie supérieure) doivent être faits *à la main*.
Pour cette raison, il vaut mieux pratiquer à dessiner les modèles en mode esquisse (à la main).
:::
Dans la méthodologie de ce manuel, on exploite l'outil PlantUML pour faire beaucoup de modèles. C'est un outil qui a plusieurs avantages:
- Il est basé sur un langage spécifique à un domaine (en anglais *domain-specific language* ou DSL), dont les fichiers peuvent être facilement mis sur un contrôle de version (Git);
- Il est basé sur du code libre;
- Il s'occupe de la mise en page des diagrammes (cela est parfois un inconvénient si un modèle est complexe);
- Il est utilisé par des ingénieurs et ingénieures chez Google pour documenter à l'interne les projets Android et Pay[^GoogleUseGizmo];
- Il existe plusieurs supports pour les outils de documentation:
- extension [PlantUML pour Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) (@fig-PlantUMLVSCode) avec [tutoriel](https://www.youtube.com/watch?v=xkwJ9GwgZJU)\ {{< fa brands youtube >}};
- extension [PlantUML Gizmo](https://gsuite.google.com/marketplace/app/plantuml_gizmo/950520042571?pann=cwsdp&hl=en) pour Google Docs et Google Slides, développée en 2014 par le professeur Christopher Fuhrman dans le cadre de son travail à l'ÉTS (@fig-PlantUMLGizmo).
[^GoogleUseGizmo]: En 2014, plusieurs employés de Google ont communiqué avec le professeur Christopher Fuhrman pour exprimer leur intérêt à utiliser l'outil [PlantUML Gizmo](https://workspace.google.com/marketplace/app/plantuml_gizmo/950520042571) dans le cadre de la documentation interne de leur projets avec Google Docs.
{#fig-PlantUMLVSCode}
Pour une personne débutante, le langage PlantUML peut sembler plus compliqué que d'utiliser un outil graphique comme Lucidchart.
Cependant, pour beaucoup de diagrammes (comme les diagrammes de séquence), ça peut être plus long à créer ou à modifier.
Bien que ces outils aient des gabarits ou des modes "UML", ceux-ci ne sont pas toujours conviviaux ou complets.
Ce sont souvent juste des objets groupés, et le vrai sens de la notation UML n'est pas considéré.
Par exemple, une ligne de vie dans un diagramme de séquence est toujours verticale, mais un éditeur graphique quelconque permet de l'orienter dans n'importe quel sens.
Ça peut prendre beaucoup de clics pour effectuer une modification, et l'on peut obtenir des résultats intermédiaires qui n'ont aucun sens en UML (voir la @fig-LucidchartUML).
Il est possible de corriger le diagramme, mais en combien de clics?
C'est très vite agaçant.
## Exemples de diagrammes avec PlantUML
Dans le menu "Select sample diagram" de PlantUML Gizmo (Google Docs), il y a plusieurs exemples de diagrammes utilisés dans le cadre de ce manuel et du livre de @craig_uml_2005 (voir la @fig-GizmoSamples).
## Astuces PlantUML
- [Comment intégrer PlantUML dans le `Readme.md` de GitHub/GitLab?](https://stackoverflow.com/q/32203610/1168342)\ {{< fa brands stack-overflow >}}
- Le serveur de PlantUML.com génère un diagramme à partir d'une URL,
`https://plantuml.com/plantuml/{forme}/{clé}`, qui contient une clé comme
`SoWkIImgAStDuKfKqBLJI5AmKaZcSaZDIm4A0G00`.
La clé est en fait une représentation compressée du code source.
- On peut changer la forme du diagramme en changeant la partie `{forme}` de l'URL:
- `{forme}` → `png`, `img` ou `svg` : représentation graphique correspondante;
- `{forme}` → `uml` : récupération du code source PlantUML.
- On peut également récupérer localement le code source d'une URL avec l'outil PlantUML avec l'option `-decodeurl {clé}` de la ligne de commande:
```bash
$ java -jar plantuml.jar -decodeurl SoWkIImgAStDuKfKqBLJI5AmKaZcSaZDIm4A0G00
@startuml
a -> b : c
@enduml
```
- Les images `png` générées par le serveur ou par l'outil contiennent une copie du code source dans les métadonnées PNG.
- On peut [récupérer le code source PlantUML à partir d'une image PNG](https://twitter.com/thefuhrmanator/status/1193565869227556868) avec un outil sur le Web comme <https://exifinfo.org/>.
- On peut également utiliser l'option `-metadata` de la ligne de commande PlantUML:
```bash
$ java -jar plantuml.jar -metadata diagram.png > diagram.puml
```
{#fig-PlantUMLGizmo}
{#fig-GizmoSamples}
{#fig-LucidchartUML}