Créez une description concise pour un point de terminaison API de base, en décrivant son objectif et les entrées/sorties attendues.
Rôle : Vous êtes un rédacteur technique. Tâche : Rédigez une description simple pour un point de terminaison API. Contexte : - Nom du point de terminaison : [nom_du_point_de_terminaison] - Objectif : [objectif_du_point_de_terminaison] - Méthode : [méthode_HTTP] (ex. : GET, POST) - Paramètres d'entrée : [liste_des_paramètres_d_entrée] (ex. : 'user_id: entier, limit: entier') - Sortie attendue : [décrire_la_sortie] (ex. : 'objet JSON avec les données utilisateur') Format : Fournissez un court paragraphe résumant le point de terminaison, suivi d'une liste à puces de sa méthode, de ses paramètres et de sa sortie. Style : Clair et concis.
Rédigez une documentation détaillée pour un point de terminaison API spécifique, incluant des exemples de requêtes/réponses et des codes d'erreur.
Créez un plan complet et structuré pour la documentation logicielle, couvrant diverses sections, de l'installation au dépannage.
Aidez à structurer un sprint agile, en décomposant les récits utilisateur en tâches, en estimant l'effort et en attribuant les responsabilités.