Skip to main content

PlantUML

Rôle

  • Documentation
  • Structuration du savoir
  • Support de schémas textuels

Exemple Markdown

# Authentification

Ce document décrit le processus de connexion utilisateur.

## Étapes
1. Saisie des identifiants
2. Vérification
3. Création de session

2. PlantUML – Diagramme d’activités (Processus)

@startuml
title ACT-AUTH-CONNEXION

|Utilisateur|
start
:Saisir identifiants;

|Application|
:Vérifier identifiants;
if (Valides ?) then (Oui)
  :Créer session;
  |Système|
  :Écrire log succès;
  stop
else (Non)
  :Refuser accès;
  |Système|
  :Écrire log erreur;
  stop
endif
@enduml

3. PlantUML – Diagramme de séquence

@startuml
actor Utilisateur
participant Front
participant API
database DB

Utilisateur -> Front : Login
Front -> API : POST /login
API -> DB : Vérification
DB --> API : OK
API --> Front : Token
Front --> Utilisateur : Connecté
@enduml

4. PlantUML – Diagramme de classes

@startuml
class User {
  id : int
  email : string
}

class Role {
  id : int
  name : string
}

User "1" -- "*" Role
@enduml

5. PlantUML – Diagramme de composants

@startuml
component Frontend
component API
component AuthService
database DB

Frontend --> API
API --> AuthService
AuthService --> DB
@enduml

6. PlantUML – Diagramme de déploiement

@startuml
node Client {
  component Navigateur
}

node Serveur {
  component Frontend
  component API
}

node DB {
  database MySQL
}

Navigateur --> Frontend
Frontend --> API
API --> MySQL
@enduml

7. PlantUML – Diagramme d’états

@startuml
[*] --> Créée
Créée --> Payée
Payée --> Expédiée
Expédiée --> Livrée
Livrée --> [*]
@enduml

8. Philosophie générale

  • Le texte est la source de vérité
  • Les schémas sont versionnés
  • La documentation est vivante
  • Un outil = un rôle clair

Conclusion

Cette approche permet :

  • une documentation maintenable
  • des schémas cohérents
  • une intégration naturelle avec Git et CI/CD

C’est une base solide pour tout projet informatique moderne.