Design Guidelines¶

Statut¶

Document de gouvernance documentaire pour le dossier design/.

Ce document définit comment les documents de design doivent être écrits, structurés et maintenus.

Rôle du dossier design¶

Le dossier design/ décrit l'architecture cible des grands composants de la Platform.

Il ne décrit pas obligatoirement l'état actuel du code.

Les écarts entre le design cible et l'implémentation actuelle sont suivis dans la documentation migration/.

Règle principale¶

Avant de créer ou migrer un composant Platform, son document de design doit exister.

Aucun composant important ne doit être développé au feeling.

Structure obligatoire¶

Chaque document de design doit suivre cette structure :

# Nom du composant

## Statut

## Mission

## Pourquoi ce composant existe

## Responsabilités

## Ce qui lui appartient

## Ce qui lui est interdit

## Dépendances autorisées

## Dépendances interdites

## Entrées

## Sorties

## Contrats utilisés

## Composants internes

## Composants legacy qui migreront ici

## Ce qui ne doit jamais venir ici

## Critères de qualité

## État d'avancement

## Évolution future