mirror of
https://github.com/MaksTinyWorkshop/_Assistant_Lead_Tech
synced 2026-04-06 21:41:42 +02:00
32 lines
660 B
Markdown
32 lines
660 B
Markdown
# Workflows documentés
|
||
|
||
Chaque workflow non trivial mérite un fichier dédié.
|
||
|
||
Objectifs :
|
||
|
||
- comprendre rapidement la logique
|
||
- reprendre un workflow sans re-debug
|
||
- expliquer un choix technique
|
||
|
||
Un fichier = un workflow.
|
||
|
||
---
|
||
|
||
## Format recommandé pour un workflow
|
||
|
||
Nom de fichier :
|
||
|
||
- `20_workflows/<nom_workflow>.md`
|
||
|
||
Contenu recommandé :
|
||
|
||
- Objectif
|
||
- Trigger(s)
|
||
- Entrées / sorties (schéma léger)
|
||
- Logique (étapes)
|
||
- Points sensibles (rate limit, pagination, idempotence, timeouts, etc.)
|
||
- Stratégie d’erreurs (retries, dead letter, notification)
|
||
- État (En test / En prod / Deprecated)
|
||
- Liens (API docs, tickets, etc.)
|
||
- Optionnel (JSON)
|