Guide7 min de lecture

Guide de la démo README d'un agent IA

Aidez les lecteurs de dépôt à comprendre une tâche navigateur.

Préparez une démo README pour une application créée par un agent IA en montrant une tâche navigateur vérifiée qui aide un lecteur à comprendre le projet.

Voir comment ça marcheLes 60 premières secondes de vidéo sont gratuites, avec un filigrane.
Vérifiez votre adresse e-mail pour la télécharger.

Une démo README d'un agent IA doit aider un lecteur de dépôt à comprendre un résultat navigateur utile sans lui demander de le déduire de notes d'implémentation. L'actif le plus efficace est court et précis. Il part d'un état reconnaissable, montre une action significative, et se termine sur le résultat qui rend le projet compréhensible. Cela suffit pour orienter un lecteur qui décide s'il doit explorer le dépôt, exécuter l'application, ou en discuter avec la personne qui l'a créée.

Un README a un rôle différent d'une page de lancement. Il donne du contexte à quelqu'un déjà proche du projet, mais il ne peut toujours pas supposer que cette personne connaît la route, les données, ou l'usage prévu. Une petite vidéo vérifiée peut répondre à la première question pratique, ce que cette application permet à une personne de faire. Elle ne doit pas affirmer que chaque route est prête, documenter chaque instruction utilisée par un agent, ni transformer une interface inachevée en une promesse large.

GogoScreen prépare un fichier MP4 narré et monté à partir d'une URL d'application web et d'une indication d'une ligne sur le parcours à montrer. Il peut utiliser un compte de démonstration quand une route pertinente se trouve derrière une connexion. Son montage annoncé inclut des zooms sur les clics, un lissage du curseur, la suppression des temps morts, et des sous-titres. Ces fonctionnalités aident à rendre un parcours sélectionné plus facile à suivre, mais un rendu peut échouer ou nécessiter une nouvelle tentative. La personne qui ajoute un actif à un README doit vérifier la route et le candidat avant de le traiter comme un outil d'orientation utile.

À quelle question une démo README doit-elle répondre ?

Une démo README doit répondre à la première question qu'un lecteur techniquement curieux se pose après avoir lu le nom du projet et la phrase d'ouverture. La question porte généralement sur un résultat, pas sur une architecture. Un lecteur peut vouloir voir si l'application crée un enregistrement, convertit une entrée en résultat, aide un utilisateur à faire un choix, ou change un état visible. Choisissez une tâche qui rend le résultat central concret sans nécessiter une longue séquence de configuration.

Utilisez une structure départ, action, résultat. Le départ montre assez de contexte pour que le lecteur identifie la fonctionnalité. L'action est le choix ou l'opération unique qui compte. Le résultat rend la valeur visible à l'écran. Cette structure est particulièrement utile quand un agent a produit de nombreux écrans rapidement, parce qu'elle donne au README une explication stable qui ne dépend pas d'une longue liste de fonctionnalités.

Énoncez le résultat navigateur qu'un lecteur de dépôt doit comprendre en premier.
Sélectionnez une action qui rend ce résultat visible sans une longue configuration.
Gardez l'état final à l'écran assez longtemps pour que le lecteur puisse l'inspecter.

Le guide de la vidéo de démo d'un agent IA explique comment un parcours vérifié devient une passation humaine pratique. Le guide de la vidéo de démo de lancement d'un agent IA applique la même structure à un lancement public, où la relecture des affirmations est plus large. Pour un changement encore à l'étude, le guide de la vidéo de démo de PR d'un agent IA garde la preuve concentrée sur un comportement proposé.

Comment choisir la bonne route ?

Choisissez une route qu'un lecteur pourrait reconnaître sans historique de compte privé. Ouvrez-la manuellement et répétez la tâche prévue avant de préparer un candidat. Vérifiez l'état d'ouverture, les redirections, les avis de cookies, les états vides, et les fenêtres qui peuvent interrompre la séquence. Une route étroite proche de l'action utile est généralement meilleure que l'écran d'accueil, surtout quand celui-ci contient de la navigation mais aucune preuve de ce que fait l'application.

Préparez des données non sensibles qui donnent du sens au résultat. N'incluez pas de nom de client, d'URL de client, de document privé, ou d'identifiant dans la route, la vidéo, ou le README. Si la tâche nécessite une authentification, utilisez un compte de démonstration jetable via le processus approuvé. Sur GogoScreen, les identifiants sont chiffrés, utilisés pour un seul rendu, puis supprimés. Si un storyboard est planifié en premier, les identifiants restent chiffrés pendant cette session et sont supprimés au plus tard deux heures après leur dernière utilisation. Les personnes qui préparent l'actif ne doivent pas les demander, les copier, ou les publier.

Besoin du lecteur	Choix de route	Preuve à garder visible
Comprendre le résultat du projet	Commencez près de la première tâche reconnaissable.	Le contexte qui explique la tâche.
Inspecter le changement significatif	Utilisez une route avec une action utilisateur.	L'action et l'état du navigateur qui en résulte.
Décider d'explorer davantage	Terminez sur le résultat sélectionné.	La limite de ce que le court actif montre.

Le guide de la vidéo de démo logicielle à partir d'une URL couvre la préparation de route pour une démonstration basée sur le navigateur. Le guide de la vidéo de journal des modifications d'un agent IA applique la même preuve ciblée à un changement accepté. Les deux approches ne fonctionnent que lorsque l'état de départ et le résultat sont assez clairs pour un lecteur qui n'a jamais ouvert l'application.

Comment l'indication doit-elle décrire la tâche du README ?

Rédigez l'indication dans le langage qu'un lecteur voit dans l'interface. Nommez le point de départ, l'action, et le résultat visible. Par exemple, une indication pourrait demander d'ouvrir un espace de travail préparé, d'accomplir une tâche visible, et de montrer l'état résultant. Elle ne doit pas demander de démontrer chaque capacité, expliquer comment l'agent a créé l'interface, ou reposer sur des termes absents de l'application.

Une indication directe crée une séquence attendue pour la personne qui vérifie le candidat. Si le candidat commence quelque part d'inattendu, s'arrête sur un état vide, ou atteint un résultat différent, le problème est visible rapidement. Cela rend l'actif README plus facile à réviser qu'une demande large de visite complète du produit.

Testez la route après avoir rédigé l'indication. Le test établit la séquence à inspecter, pas une garantie que le rendu fonctionnera. Si la tâche dépend d'une configuration cachée, préparez des données sûres ou sélectionnez un parcours plus petit. Le guide de la démo d'un ticket GitHub d'un agent IA applique la même précision quand un collègue doit inspecter une tâche bornée. Une vidéo de démo d'un agent de codage peut fournir une preuve navigateur associée quand la question porte sur un changement technique plutôt que sur l'orientation du dépôt.

Que doit vérifier la personne qui rédige le README ?

Vérifiez si le candidat répond à la question prévue sans la seule narration. Regardez-le d'abord en muet. L'image d'ouverture doit donner assez de contexte pour identifier la tâche, l'action doit être visible, et le résultat ne doit pas dépendre d'une explication non prononcée. Comparez ensuite la narration et les sous-titres avec la séquence du navigateur. Une description n'est utile que lorsqu'elle correspond précisément à ce qui apparaît à l'écran.

Vérifiez aussi la présence de contenu inadapté à une page de dépôt. Cherchez des données privées, des détails de client, un travail inachevé, des libellés trompeurs, et des écrans sans lien. Un fichier terminé n'est pas une approbation automatique. Si le candidat nécessite une nouvelle tentative, notez si la route, l'état préparé, ou l'indication a causé le problème, puis vérifiez la version suivante par rapport à la même tâche.

Chaque nouveau compte reçoit 60 secondes de vidéo une seule fois, avec filigrane. Ensuite, les vidéos utilisent du temps d'un forfait ou d'une recharge, et le temps n'est utilisé que lorsqu'un rendu réussit. Ces limites produit récompensent une histoire README concise. Un lecteur doit pouvoir comprendre le résultat du projet en un seul passage plutôt que de chercher dans un long enregistrement le moment qui compte.

Où la démo doit-elle se placer dans un README ?

Placez la démo près de l'explication d'ouverture du projet, là où elle peut confirmer l'affirmation que le lecteur vient de rencontrer. Une courte phrase peut énoncer la tâche que l'application aide à accomplir, et la vidéo peut montrer la tâche observée. Gardez l'installation, la configuration, et le contenu de développement séparés de l'explication visuelle afin que les lecteurs puissent choisir la profondeur dont ils ont besoin.

Une démo de dépôt n'a pas besoin de faire le travail d'une page de lancement. Le guide de la démo d'automatisation de navigateur d'un agent IA décrit comment rendre une séquence sélectionnée inspectable. Le guide de la vidéo de démo SaaS aide à choisir une tâche utilisateur pertinente pour un acheteur quand l'application a plusieurs histoires possibles. Le guide de la vidéo de démo produit README aide à évaluer quand un lecteur de dépôt a besoin d'une vidéo plutôt que d'un court actif. Pour les choix d'enregistrement manuel, GogoScreen contre Loom et GogoScreen contre Screen Studio comparent l'effort nécessaire pour préparer un parcours navigateur ciblé.

Commencez par la page d'accueil de GogoScreen pour revoir le flux de travail de l'URL et de l'indication. Consultez la page tarifs pour les forfaits et recharges, et lisez la politique de confidentialité avant qu'une route utilise un compte de démonstration. La décision finale revient à la personne qui peut confirmer que le texte du README, la tâche visible, et la vidéo candidate décrivent tous le même résultat vérifié.

Précisions

Avant de commencer

Que doit montrer une démo README d'un agent IA ?

Montrez une tâche navigateur qui aide rapidement un lecteur de dépôt à comprendre le projet. Établissez le contexte de départ, effectuez l'action importante, et montrez le résultat visible après qu'une personne a vérifié la route et le candidat.

Une démo README doit-elle expliquer comment l'agent a créé l'application ?

Généralement non. Un lecteur de README a besoin de comprendre l'application qu'il peut exécuter ou inspecter. Gardez l'historique d'implémentation dans le compte rendu de développement, et utilisez la démo pour montrer un résultat observable dans le navigateur.

Une démo README peut-elle utiliser une route derrière une connexion ?

Elle peut utiliser une route de démonstration préparée quand le parcours nécessite une authentification. Ne placez pas d'identifiants dans le README ou la vidéo. La route et le candidat ont toujours besoin d'une vérification humaine avant d'être partagés.

Collez une URL, décrivez un parcours et obtenez une vidéo de démonstration de votre application web.

Les 60 premières secondes de vidéo sont gratuites, avec un filigrane. Vérifiez votre adresse e-mail pour télécharger la vidéo.

Voir les tarifs Lire les guides