Proprietes semantiques | Documentation Siovos Archi

Au-dela du nom et du type, les proprietes semantiques vous permettent de documenter des informations cruciales sur chaque composant : son statut de deploiement, sa criticite, son responsable, son repository. Ces informations enrichissent votre architecture et alimentent des fonctionnalites comme l'analyse d'impact.

Proprietes des Nodes#

Chaque node peut etre enrichi avec les proprietes suivantes :

Status#

Le status indique l'etat de deploiement du composant :

Status	Description	Couleur
`draft`	En cours de conception	Gris
`review`	En cours de validation	Jaune
`approved`	Valide, pret a deployer	Bleu
`production`	En production	Vert
`deprecated`	En cours de deprecation	Orange

Le status s'affiche avec un badge colore dans le panneau de proprietes et peut etre visible sur le node.

Criticite#

La criticite indique l'importance du composant pour le systeme :

Niveau	Signification
`low`	Impact mineur en cas de defaillance
`medium`	Impact modere, degradation du service
`high`	Impact majeur, perte de fonctionnalite
`critical`	Impact total, arret du service

L'analyse d'impact utilise la criticite pour alerter sur les consequences d'une modification.

Les composants marques critical generent des avertissements dans l'analyse d'impact quand ils sont dans la chaine de dependance.

Owner#

Le responsable du composant, generalement un membre de l'equipe ou une equipe :

Email : alice@company.com
Nom d'equipe : Team Backend
Alias : @alice

L'owner est utile pour savoir qui contacter en cas de question ou d'incident.

Repository#

Lien vers le repository de code :

GitHub : https://github.com/company/api-gateway
GitLab : https://gitlab.company.com/backend/users-service

Facilite la navigation vers le code source depuis le diagramme.

Documentation#

Lien vers la documentation technique :

Confluence : https://wiki.company.com/pages/api-gateway
Notion : https://notion.so/company/api-gateway
README : https://github.com/company/api-gateway#readme

Environnement#

L'environnement de deploiement :

Valeur	Description
`development`	Environnement de dev
`staging`	Pre-production
`production`	Production
`dr`	Disaster recovery

Proprietes des Connexions#

Les connexions peuvent egalement etre enrichies :

Type de relation#

Indique la nature de la relation :

Type	Description
`depends_on`	Dependance technique
`calls`	Appel synchrone (HTTP, gRPC)
`stores_in`	Ecriture de donnees
`reads_from`	Lecture de donnees
`authenticates_via`	Flux d'authentification
`routes_to`	Routage reseau
`replicates_to`	Replication

Criticite de la relation#

Meme echelle que pour les nodes :

Une connexion critical entre deux nodes signale un lien vital
L'analyse d'impact met en evidence ces connexions

Data Flow#

Decrit ce qui transite :

user-data : Donnees utilisateur
auth-tokens : Tokens d'authentification
metrics : Metriques
logs : Logs

Description#

Texte libre pour documenter la connexion :

"Synchronisation toutes les 5 minutes"
"Webhook de notification"
"Fallback si le primaire est indisponible"

Progressive Disclosure#

Les proprietes semantiques utilisent un systeme de progressive disclosure dans le panneau de proprietes :

Vue resumee : Seules les proprietes renseignees sont visibles
Vue complete : Cliquez sur "Plus d'options" pour voir toutes les proprietes disponibles

Cela garde l'interface claire pour les utilisations simples tout en permettant un enrichissement complet.

Utilisation dans l'analyse d'impact#

Les proprietes semantiques alimentent l'analyse d'impact :

Alertes de criticite#

Quand vous analysez l'impact d'un changement, les composants critiques dans la chaine de dependance sont mis en evidence avec un avertissement.

Parcours par type de relation#

L'analyse distingue :

Les dependances directes (depends_on, calls)
Les flux de donnees (stores_in, reads_from)
Les relations secondaires (routes_to)

Owner dans le rapport#

Le rapport d'impact liste les owners des composants affectes, facilitant la coordination.

Bonnes pratiques#

Renseignez les proprietes critiques#

Au minimum, renseignez :

Status : Pour savoir si le composant est en production
Criticite : Pour l'analyse d'impact
Owner : Pour savoir qui contacter

Maintenez a jour#

Les proprietes semantiques ont de la valeur si elles sont a jour. Integrez leur mise a jour dans vos processus :

Passage en production → Status = production
Deprecation planifiee → Status = deprecated
Changement d'equipe → Owner mis a jour

Types de relation coherents#

Utilisez les types de relation de maniere coherente :

calls pour les appels HTTP/RPC synchrones
stores_in / reads_from pour les acces base de donnees
depends_on pour les dependances d'infrastructure

Documentation externe#

Utilisez les champs Repository et Documentation pour lier vers les sources externes. Le diagramme devient un point d'entree vers toute la documentation technique.

Affichage sur le canvas#

Par defaut, seul le label est affiche sur les nodes. Vous pouvez controler l'affichage des proprietes :

Dans la toolbar, trouvez le toggle Afficher metadonnees
Les proprietes selectionnees s'affichent sur les nodes

Pour les presentations, masquez les metadonnees pour une vue epuree.

Export#

Les proprietes semantiques sont incluses dans l'export JSON de votre architecture. Elles peuvent etre utilisees pour :

Generer de la documentation automatique
Alimenter un CMDB
Integration avec des outils d'observabilite

Prochaines etapes#

Analyse d'impact pour voir les proprietes en action
Types de Nodes pour la liste des composants
Connexions pour les types de relations