Génération et mise à jour d’un fichier README avec Amazon Q Developer - Amazon Q Developer

Génération et mise à jour d’un fichier README avec Amazon Q Developer

Note

Vous pouvez demander à générer de la documentation directement dans le chat. Si vous utilisez /doc, votre demande est redirigée vers le chat. Essayez de demander generate documentation for my application.

Avant de démarrer, assurez-vous d’avoir installé Amazon Q dans un IDE prenant en charge la génération de documentation. Pour plus d’informations, consultez Installation de l’extension ou du plug-in Amazon Q Developer dans votre IDE.

Pour générer ou mettre à jour des fichiers README avec Amazon Q dans l’IDE, procédez comme suit :

  1. Ouvrez l’IDE dans lequel l’extension Amazon Q est installée.

  2. Choisissez l’icône d’Amazon Q pour ouvrir le volet. Saisissez /doc.

  3. Un nouvel onglet s’ouvre. Amazon Q vous invite à créer un fichier README pour votre code ou à mettre à jour un fichier README existant.

  4. Choisissez le type de tâche de documentation sur laquelle vous souhaitez travailler.

    Si vous mettez à jour un fichier README existant, choisissez si vous souhaitez qu’Amazon Q mette à jour votre fichier README sur la bade des modifications récentes du code, ou si vous souhaitez qu’Amazon Q apporte des modifications spécifiques à votre fichier README.

  5. Amazon Q vous invite à confirmer que vous souhaitez générer la documentation pour le dossier actuellement ouvert dans votre IDE. Vous pouvez choisir un nouveau dossier.

    Si vous avez choisi d’apporter des modifications spécifiques à votre fichier README, décrivez en détail les mises à jour que vous souhaitez qu’Amazon Q apporte. Pour avoir une idée des éléments à inclure dans votre description, consultez Bonnes pratiques.

    Amazon Q commence à générer votre documentation. Si le dossier de votre projet contient des fichiers d’infrastructure en tant que code, Amazon Q crée des schémas d’infrastructure qui sont publiés dans les fichiers infra.svg du dossier docs et référencés dans le fichier README.

  6. Une fois qu’Amazon Q a généré vos documents, il fournit une version comparative comprenant toutes les modifications. Vous pouvez passer en revue les modifications, puis choisir Accepter dans le chat pour mettre à jour votre fichier README.

    Si vous voulez apporter des modifications à la documentation générée, choisissez Apporter des modifications. Vous pouvez ensuite décrire les modifications souhaitées et Amazon Q génère un fichier README mis à jour.