US X : En tant que [...] je souhaite [...] afin de [...] (Template)

[Objectif de cette description complète : Avoir suffisamment de détails pour que quelqu'un qui débarque dans le projet puisse implémenter la US.

Conseil pour la rédaction : Sur base de votre description, deux développeurs travaillant indépendamment doivent arriver au même résultat ]

Description, intérêt et objectif

[Explication détaillée de la fonctionnalité]

Critères d'acceptation

[Les éléments qui doivent être validés pour que la US soit considérée comme "DONE"]

Validations fonctionnelles spécifiques à la US

[Par exemple :

• Lorsque l'utilisateur non connecté clique sur le bouton "s'enregistrer" sur l'en-tête de n'importe quel page, il est redirigé vers un formulaire de création de compte/profil.

• Lorsque l'utilisateur encode les informations de son profil et soumet le formulaire :

  • Si les informations respectent le format demandé et ne constituent pas un doublon avec la DB : Le profil est créé et l'utilisateur est redirigé vers la page reprenant les informations du profil
  • Si les informations ne sont pas conformes, un popup d'erreur s'affiche et invite l'utilisateur à corriger les informations en mettant en rouge les informations concernées.
    ]

Validations génériques

[Les critères choisis par votre équipe et applicables à toutes vos US.

Par ex :

• La US est couverte par plusieurs tests unitaires, et tous les tests passent
• Le taux de couverture de test de la US est de min XX %
• Le client a testé lui-même la US et l'a validée
• Au moins un autre développeur a fait une "review de code"
• Le code de la US est déployé sur la branche production
• La documentation de la US est réalisée
• ... ]

Apparence / Layout

Emplacement

[Expliquer comment atteindre cette fonctionnalité en termes de navigation, de connexion, ...]

Maquettes

[Mock-ups, dessins, schémas permettant de comprendre l'apparence et l'agencement des pages web implémentant la fonctionnalité]

Dépendances techniques

Prérequis

[Ce qui doit avoir été réalisé préalablement à l'implémentation de cette US]

Utilisation de l'API

[Liste des endpoints de l'API utilisés]

Librairies

[Librairies nécessaires pour l'implémentation de la US]

Impact sur la DB

[Utilisation de la DB en lecture? En écriture? Sur quelles tables?]

Découpage en tâches

• Tâche 1
• Tâche 2 ...

• Estimation du temps de réalisation