Vibes Immaculées
On vous demande de passer en revue cette base de code codée à la va-vite. On ne vous demande pas de corriger les problèmes que vous trouvez, seulement de donner des recommandations.
Processus
Le processus de haut niveau est le suivant :
- Rassembler toute la documentation produit disponible.
- Poser des questions à l'utilisateur pour approfondir votre compréhension de l'application.
- Passer en revue le code en fonction des piliers de qualité.
- Créer un rapport avec vos conclusions.
Piliers de qualité
Voici les piliers de l'écriture d'un logiciel de haute qualité. Listés par ordre d'importance, utilisez-les comme lentille pour visualiser ce projet.
- Sécurité – Authentification, autorisations, exposition de données et comportement navigateur non sécurisé.
- Fiabilité – Flux critiques, santé des routes, assertions, erreurs console et états cassés.
- Performance – Comportement au chargement, réactivité, ressources coûteuses et latence visible par l'utilisateur.
- UI/UX – Navigation, clarté, validation, attentes de contenu et cohésion visuelle.
- Accessibilité – Accès clavier, sémantique, labels, ARIA, contraste et signaux pour les technologies d'assistance.
Processus détaillé
1. Rassembler la documentation produit disponible
Dans cette phase, vous chercherez toute documentation produit disponible. Cela posera les bases de votre revue, alors trouvez tout ce qui peut être lié aux piliers de qualité.
Endroits courants à consulter :
- PRODUCT.md
- PRD.md
- README.md
- docs/
2. Poser des questions à l'utilisateur
La documentation produit peut être incomplète ou décalée par rapport à l'état actuel de l'application. Posez des questions à l'utilisateur qui vous aideront à approfondir votre compréhension du projet et de ses besoins. Si disponible, utilisez l'outil de questionnement ; sinon, discutez avec l'utilisateur.
Exemples de questions :
- Qui a besoin d'accéder à cette application ?
- Quel est le plan pour la maintenance continue ?
- Comment allez-vous surveiller cette application et vérifier ses performances et sa fiabilité ?
- Où cette application va-t-elle être hébergée ?
3. Examiner le code
En utilisant les informations que vous avez rassemblées, lancez des sous-agents pour examiner le code pour chaque pilier de qualité. Gardez-les séparés pour éviter de polluer le contexte. Chargez-les de trouver des problèmes et de fournir une évaluation feu vert/rouge basée sur leur pilier de qualité individuel.
Chaque problème :
- doit être un problème concret et actionnable
- inclut une évaluation d'impact du problème
- Attribuez un de ces niveaux d'impact à chaque problème : Bloquant, Critique, Modéré, ou Souhaitable
- comprend une description claire du problème ainsi que les noms de fichier et numéros de ligne concernés (le cas échéant)
- fournit une recommandation pour une solution
4. Créer un rapport
Terminez en rassemblant tous les résultats des sous-agents et créez un rapport HTML détaillé, puis donnez un résumé de haut niveau dans le chat. Ouvrez le rapport HTML dans le navigateur pour que l'utilisateur puisse le consulter.
Caractéristiques clés du rapport :
- Une recommandation feu vert/rouge
- Exigences : résumé de haut niveau du produit et de ses exigences principales
- Problèmes : une liste des problèmes trouvés, classés par niveau d'impact du plus grave au moins grave
- Autres informations : toute autre constatation importante qu'un relecteur devrait connaître
Exemple de rapport :
Recommandation : Rouge
Le classement de cafés Fourgrounds est une application publique qui permet aux clients du café Fourgrounds de classer leurs boissons caféinées préférées.
Exigences principales :
- L'utilisateur doit voir une liste des boissons actuellement disponibles chez Fourgrounds
- L'utilisateur doit pouvoir glisser-déposer pour réorganiser les boissons selon son classement préféré
- L'utilisateur doit pouvoir soumettre son classement et être récompensé par un bon pour un article de boulangerie gratuit de son choix
- L'utilisateur ne doit pouvoir soumettre son classement qu'une seule fois
Problèmes :
L'utilisateur peut soumettre plusieurs fois le jeudi
Impact : CRITIQUE – L'utilisateur peut accumuler plusieurs récompenses gratuites.
En raison d'une erreur dans l'analyse de la date dans date.js ligne : 42, une exception non gérée peut entraîner le saut de la vérification d'une soumission précédente dans check-reward.js ligne : 16.
Recommandation : Utiliser l'analyseur de date intégré et encapsuler l'analyse de la date dans un try/catch pour éviter que les exceptions n'affectent d'autres parties de l'application.
Autres informations :
- Le fichier
coffee-products.jsonest généré quotidiennement. Si les produits changent en cours de journée, celui-ci pourrait être obsolète. Les consommateurs externes des classements doivent veiller à valider l'existence des produits.