a7de6a488b
Validé sur PC Windows (DESKTOP-58D5CAC, 2560x1600) : - 8 clics résolus visuellement (1 anchor_template, 1 som_text_match, 6 som_vlm) - Score moyen 0.75, temps moyen 1.6s - Texte tapé correctement (bonjour, test word, date, email) - 0 retries, 2 actions non vérifiées (OK) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
114 lines
6.9 KiB
Markdown
114 lines
6.9 KiB
Markdown
# Requirements Document - Documentation Interactive des Outils
|
|
|
|
## Introduction
|
|
|
|
Système de documentation interactive intégré dans l'interface utilisateur du Visual Workflow Builder pour expliquer en français le fonctionnement, la configuration et l'utilisation de chaque outil disponible dans la palette.
|
|
|
|
## Glossary
|
|
|
|
- **Outil**: Un type de nœud disponible dans la palette (ex: Cliquer, Base de données, Condition)
|
|
- **Palette**: Le panneau latéral contenant tous les outils disponibles
|
|
- **Panneau_Propriétés**: Le panneau de configuration qui apparaît quand un nœud est sélectionné
|
|
- **Documentation_Interactive**: Système d'aide contextuelle accessible directement dans l'interface
|
|
- **Popup_Documentation**: Fenêtre modale affichant la documentation détaillée d'un outil
|
|
- **Onglet_Documentation**: Section du panneau des propriétés dédiée à l'aide
|
|
|
|
## Requirements
|
|
|
|
### Requirement 1: Documentation dans la Palette
|
|
|
|
**User Story:** En tant qu'utilisateur, je veux accéder rapidement à la documentation d'un outil depuis la palette, afin de comprendre son utilité avant de l'ajouter à mon workflow.
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. WHEN un utilisateur survole un outil dans la palette, THE System SHALL afficher un bouton d'aide "?" visible
|
|
2. WHEN un utilisateur clique sur le bouton "?" d'un outil, THE System SHALL ouvrir un popup avec la documentation complète de cet outil
|
|
3. THE Popup_Documentation SHALL contenir le titre, la description, les cas d'usage, les paramètres et des exemples pratiques
|
|
4. WHEN un utilisateur clique en dehors du popup ou sur le bouton fermer, THE System SHALL fermer le popup de documentation
|
|
5. THE System SHALL maintenir la fonctionnalité de drag-and-drop des outils même avec le bouton d'aide présent
|
|
|
|
### Requirement 2: Documentation dans le Panneau des Propriétés
|
|
|
|
**User Story:** En tant qu'utilisateur, je veux consulter la documentation d'un outil pendant que je le configure, afin de comprendre chaque paramètre et optimiser ma configuration.
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. WHEN un nœud est sélectionné sur le canvas, THE Panneau_Propriétés SHALL afficher un onglet "Documentation" en plus des onglets existants
|
|
2. THE Onglet_Documentation SHALL contenir la documentation complète de l'outil correspondant au nœud sélectionné
|
|
3. WHEN aucun nœud n'est sélectionné, THE Onglet_Documentation SHALL afficher une aide générale sur l'utilisation des workflows
|
|
4. THE System SHALL synchroniser automatiquement le contenu de l'onglet avec le type de nœud sélectionné
|
|
5. THE Onglet_Documentation SHALL rester accessible pendant la configuration des paramètres
|
|
|
|
### Requirement 3: Contenu de Documentation Complet
|
|
|
|
**User Story:** En tant qu'utilisateur français, je veux une documentation détaillée et claire en français pour chaque outil, afin de maîtriser parfaitement leur utilisation.
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. THE System SHALL fournir une documentation en français pour chaque outil de la palette
|
|
2. THE Documentation SHALL inclure une description claire du rôle de l'outil
|
|
3. THE Documentation SHALL lister tous les paramètres configurables avec leurs explications
|
|
4. THE Documentation SHALL présenter des exemples concrets d'utilisation
|
|
5. THE Documentation SHALL mentionner les bonnes pratiques et limitations éventuelles
|
|
6. THE Documentation SHALL inclure des cas d'usage typiques pour chaque outil
|
|
|
|
### Requirement 4: Documentation Spécialisée par Catégorie
|
|
|
|
**User Story:** En tant qu'utilisateur, je veux une documentation adaptée à chaque catégorie d'outils, afin de comprendre les spécificités de chaque domaine (Actions Web, Données, Logique, etc.).
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. THE System SHALL adapter le format de documentation selon la catégorie d'outil
|
|
2. FOR Actions Web tools, THE Documentation SHALL expliquer les interactions avec l'interface utilisateur
|
|
3. FOR Données tools, THE Documentation SHALL détailler les types de données et transformations possibles
|
|
4. FOR Logique tools, THE Documentation SHALL expliquer les conditions et structures de contrôle
|
|
5. FOR Intégrations tools, THE Documentation SHALL préciser les protocoles et configurations de connexion
|
|
6. THE Documentation SHALL inclure des schémas visuels quand approprié
|
|
|
|
### Requirement 5: Recherche dans la Documentation
|
|
|
|
**User Story:** En tant qu'utilisateur, je veux pouvoir rechercher dans la documentation des outils, afin de trouver rapidement l'information dont j'ai besoin.
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. THE Popup_Documentation SHALL inclure un champ de recherche interne
|
|
2. WHEN un utilisateur tape dans le champ de recherche, THE System SHALL surligner les termes correspondants dans la documentation
|
|
3. THE System SHALL permettre la navigation entre les résultats de recherche
|
|
4. THE Recherche SHALL fonctionner sur le titre, la description, les paramètres et les exemples
|
|
5. WHEN aucun résultat n'est trouvé, THE System SHALL afficher un message informatif
|
|
|
|
### Requirement 6: Documentation Contextuelle Avancée
|
|
|
|
**User Story:** En tant qu'utilisateur, je veux que la documentation s'adapte au contexte de mon workflow, afin de recevoir des conseils pertinents selon ma situation.
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. WHEN un nœud a des paramètres déjà configurés, THE Documentation SHALL mettre en évidence les sections correspondantes
|
|
2. THE System SHALL suggérer des outils complémentaires basés sur l'outil actuellement consulté
|
|
3. WHEN un outil est utilisé dans un contexte spécifique, THE Documentation SHALL adapter ses exemples
|
|
4. THE System SHALL afficher des avertissements si la configuration actuelle présente des risques
|
|
5. THE Documentation SHALL proposer des liens vers d'autres outils connexes
|
|
|
|
### Requirement 7: Accessibilité et Ergonomie
|
|
|
|
**User Story:** En tant qu'utilisateur, je veux une documentation accessible et ergonomique, afin de pouvoir l'utiliser efficacement quel que soit mon niveau d'expertise.
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. THE Documentation SHALL être accessible via raccourcis clavier (F1 sur un outil sélectionné)
|
|
2. THE System SHALL supporter la navigation au clavier dans les popups de documentation
|
|
3. THE Documentation SHALL utiliser une typographie claire et des contrastes suffisants
|
|
4. THE System SHALL permettre d'ajuster la taille de police de la documentation
|
|
5. THE Documentation SHALL être responsive et s'adapter à différentes tailles d'écran
|
|
|
|
### Requirement 8: Performance et Chargement
|
|
|
|
**User Story:** En tant qu'utilisateur, je veux que la documentation se charge rapidement, afin de ne pas interrompre mon flux de travail.
|
|
|
|
#### Acceptance Criteria
|
|
|
|
1. THE System SHALL charger la documentation de base au démarrage de l'application
|
|
2. THE Documentation SHALL s'afficher en moins de 200ms après un clic sur le bouton d'aide
|
|
3. THE System SHALL mettre en cache la documentation pour éviter les rechargements
|
|
4. WHEN la documentation est volumineuse, THE System SHALL implémenter un chargement progressif
|
|
5. THE System SHALL fonctionner hors ligne une fois la documentation chargée |