Initial commit
This commit is contained in:
Dom
187
docs/reference/README.md
Normal file
187
docs/reference/README.md
Normal file
@@ -0,0 +1,187 @@
|
||||
# Documentation de Référence - RPA Vision V2
|
||||
|
||||
Ce dossier contient la documentation architecturale et technique de référence pour le projet RPA Vision V2.
|
||||
|
||||
---
|
||||
|
||||
## 📚 Documents Disponibles
|
||||
|
||||
### 🏗️ [ARCHITECTURE_VISION_COMPLETE.md](./ARCHITECTURE_VISION_COMPLETE.md)
|
||||
|
||||
**Document principal** décrivant l'architecture complète du système en 5 couches.
|
||||
|
||||
**À lire si vous voulez** :
|
||||
- Comprendre l'architecture globale du système
|
||||
- Connaître les formats JSON de toutes les structures
|
||||
- Voir un exemple concret de bout en bout
|
||||
- Planifier une migration ou implémentation
|
||||
|
||||
**Taille** : ~1500 lignes | **Temps de lecture** : 30-45 min
|
||||
|
||||
---
|
||||
|
||||
### 📑 [ARCHITECTURE_INDEX.md](./ARCHITECTURE_INDEX.md)
|
||||
|
||||
**Index de navigation** pour accéder rapidement aux sections du document principal.
|
||||
|
||||
**À utiliser pour** :
|
||||
- Navigation rapide par couche, cas d'usage ou concept
|
||||
- Trouver une section spécifique
|
||||
- Vue d'ensemble des contenus
|
||||
|
||||
**Taille** : ~150 lignes | **Temps de lecture** : 5 min
|
||||
|
||||
---
|
||||
|
||||
### 📊 [CHANGELOG_MVP.md](./CHANGELOG_MVP.md)
|
||||
|
||||
**Historique des changements** du MVP et des versions.
|
||||
|
||||
**À consulter pour** :
|
||||
- Suivre l'évolution du projet
|
||||
- Comprendre les décisions architecturales
|
||||
- Voir les fonctionnalités ajoutées
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Par Où Commencer ?
|
||||
|
||||
### Si vous êtes nouveau
|
||||
|
||||
1. **Lire** : [ARCHITECTURE_INDEX.md](./ARCHITECTURE_INDEX.md) (5 min)
|
||||
2. **Explorer** : [ARCHITECTURE_VISION_COMPLETE.md](./ARCHITECTURE_VISION_COMPLETE.md) - Vue d'ensemble
|
||||
3. **Approfondir** : Sections spécifiques selon vos besoins
|
||||
|
||||
### Si vous voulez implémenter
|
||||
|
||||
1. **Comprendre** : Les 5 couches de l'architecture
|
||||
2. **Étudier** : L'exemple "Validation Facture T2A"
|
||||
3. **Suivre** : Le plan de migration (Phase 1-6)
|
||||
4. **Coder** : En commençant par les structures de données
|
||||
|
||||
### Si vous cherchez quelque chose de précis
|
||||
|
||||
1. **Utiliser** : [ARCHITECTURE_INDEX.md](./ARCHITECTURE_INDEX.md)
|
||||
2. **Naviguer** : Vers la section appropriée
|
||||
3. **Lire** : Les exemples JSON et propositions
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Architecture en 5 Couches
|
||||
|
||||
```
|
||||
Couche 0 : RawSession
|
||||
↓
|
||||
Couche 1 : ScreenState
|
||||
↓
|
||||
Couche 2 : UIElement Detection
|
||||
↓
|
||||
Couche 3 : State Embedding
|
||||
↓
|
||||
Couche 4 : Workflow Graph
|
||||
```
|
||||
|
||||
Chaque couche transforme les données brutes en connaissances actionnables.
|
||||
|
||||
---
|
||||
|
||||
## 💡 Points Clés
|
||||
|
||||
### Philosophie
|
||||
|
||||
**"Observer → Comprendre → Apprendre → Agir"**
|
||||
|
||||
Le système apprend progressivement des workflows utilisateur et évolue de l'observation passive à l'exécution automatique.
|
||||
|
||||
### Learning States
|
||||
|
||||
```
|
||||
OBSERVATION → COACHING → AUTO_CANDIDATE → AUTO_CONFIRMÉ
|
||||
```
|
||||
|
||||
Progression formalisée avec critères mesurables à chaque étape.
|
||||
|
||||
### Robustesse
|
||||
|
||||
- **Matching sémantique** (pas de coordonnées fixes)
|
||||
- **Détection de changements** d'UI automatique
|
||||
- **Safety rules** configurables
|
||||
- **Rétrogradation** automatique si problème
|
||||
|
||||
---
|
||||
|
||||
## 📊 Formats de Données
|
||||
|
||||
Tous les formats JSON sont documentés avec :
|
||||
- ✅ Structure complète
|
||||
- ✅ Description de chaque champ
|
||||
- ✅ Exemples réels
|
||||
- ✅ Propositions d'amélioration
|
||||
|
||||
**Formats disponibles** :
|
||||
- RawSession
|
||||
- ScreenState
|
||||
- UIElement
|
||||
- WorkflowNode
|
||||
- WorkflowEdge
|
||||
- Workflow complet
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Plan de Migration
|
||||
|
||||
Le document inclut un **plan de migration progressif en 6 phases** (14 semaines) :
|
||||
|
||||
1. **Phase 1** : Fondations (structures de données)
|
||||
2. **Phase 2** : UIElement Detection
|
||||
3. **Phase 3** : State Embedding
|
||||
4. **Phase 4** : Workflow Graph
|
||||
5. **Phase 5** : Learning States
|
||||
6. **Phase 6** : Production
|
||||
|
||||
Chaque phase est détaillée avec objectifs, tâches et livrables.
|
||||
|
||||
---
|
||||
|
||||
## 📈 Métriques de Succès
|
||||
|
||||
Le document définit des métriques claires pour :
|
||||
- **Qualité de détection** (précision, rappel)
|
||||
- **Qualité d'apprentissage** (workflows détectés, taux de succès)
|
||||
- **Performance système** (latence, mémoire)
|
||||
|
||||
---
|
||||
|
||||
## 🔒 Sécurité
|
||||
|
||||
Considérations de sécurité incluses :
|
||||
- Chiffrement des captures
|
||||
- Anonymisation des données sensibles
|
||||
- Safety rules et validation
|
||||
- Audit trail complet
|
||||
|
||||
---
|
||||
|
||||
## 📞 Support
|
||||
|
||||
Pour toute question ou contribution :
|
||||
- 📝 Créer une issue sur le projet
|
||||
- 💬 Discuter dans les channels de l'équipe
|
||||
- 📧 Contacter les mainteneurs
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Mises à Jour
|
||||
|
||||
Ce dossier est maintenu activement. Consultez régulièrement pour :
|
||||
- Nouvelles propositions d'amélioration
|
||||
- Mises à jour des formats JSON
|
||||
- Retours d'expérience d'implémentation
|
||||
- Optimisations et best practices
|
||||
|
||||
---
|
||||
|
||||
**Dernière mise à jour** : 22 novembre 2024
|
||||
**Version** : 1.0
|
||||
**Statut** : ✅ Documentation Complète
|
||||
|
||||
Reference in New Issue
Block a user