Guia7 min de leitura

Guia de Demo README de Agente de IA

Ajude leitores de repositório a compreender uma tarefa de navegador.

Planeie uma demo README para uma app web criada por agente, com uma tarefa de navegador verificada que ajude um leitor de repositório a compreender o projeto.

Ver como funcionaOs primeiros 60 segundos de vídeo são gratuitos, com marca de água.
Verifique o seu correio eletrónico para o descarregar.

Uma demo README de agente de IA deve ajudar um leitor de repositório a compreender um resultado de navegador útil sem lhe pedir que o infira a partir de notas de implementação. O ativo mais eficaz é curto e específico. Começa a partir de um estado reconhecível, mostra uma ação relevante e termina no resultado que torna o projeto compreensível. Isso é suficiente para orientar um leitor que está a decidir se explora o repositório, executa a app ou fala sobre ela com quem a fez.

Um README tem um trabalho diferente do de uma página de lançamento. Dá contexto a alguém que já está próximo do projeto, mas ainda não pode presumir que conhece a rota, os dados ou o uso pretendido. Um vídeo pequeno e verificado consegue responder à primeira pergunta prática, o que é que esta app deixa uma pessoa fazer. Não deve alegar que todas as rotas estão prontas, documentar cada instrução usada por um agente ou transformar uma interface inacabada numa promessa ampla.

O GogoScreen prepara um MP4 narrado e editado a partir de um URL de app web e de uma indicação de uma linha sobre o fluxo a mostrar. Pode usar uma conta de demonstração quando uma rota relevante está atrás de um início de sessão. A sua edição declarada inclui zooms em cliques, suavização do cursor, cortes de silêncio e legendas. Essas funcionalidades ajudam a tornar um fluxo selecionado mais fácil de seguir, mas uma renderização pode falhar ou precisar de um novo intento. A pessoa que acrescenta um ativo a um README deve verificar a rota e o candidato antes de o tratar como uma ferramenta de orientação útil.

Que pergunta deve uma demo README responder?

Uma demo README deve responder à primeira pergunta que um leitor tecnicamente curioso tem depois de ler o nome do projeto e a frase de abertura. A pergunta é normalmente sobre um resultado, não sobre uma arquitetura. Um leitor pode querer ver se a app cria um registo, converte uma entrada num resultado, ajuda um utilizador a fazer uma escolha ou muda um estado visível. Escolha uma tarefa que torne o resultado central concreto sem exigir uma sequência de configuração alargada.

Use uma estrutura de início, ação, resultado. O início mostra contexto suficiente para o leitor identificar a funcionalidade. A ação é a única escolha ou operação que importa. O resultado torna o valor visível no ecrã. Esta estrutura é especialmente útil quando um agente produziu muitos ecrãs rapidamente, porque dá ao README uma explicação estável que não depende de uma lista longa de funcionalidades.

Declare o resultado de navegador que um leitor de repositório deve compreender primeiro.
Selecione uma ação que torne esse resultado visível sem uma configuração longa.
Mantenha o estado final no ecrã tempo suficiente para o leitor o inspecionar.

O guia de vídeo demo de agente de IA explica como um único fluxo verificado se torna uma transição humana prática. O guia de vídeo demo de lançamento de agente de IA aplica a mesma estrutura a um lançamento público, onde a revisão da afirmação é mais ampla. Para uma alteração ainda em consideração, o guia de vídeo demo de PR de agente de IA mantém a evidência focada num comportamento proposto.

Como escolher a rota certa?

Escolha uma rota que um leitor consiga reconhecer sem histórico de conta privado. Abra-a manualmente e repita a tarefa pretendida antes de preparar um candidato. Verifique o estado de abertura, os redirecionamentos, os avisos de cookies, os estados vazios e as sobreposições que possam interromper a sequência. Uma rota restrita próxima da ação útil é normalmente melhor do que o ecrã inicial, especialmente quando o ecrã inicial contém navegação mas nenhuma evidência do que a app faz.

Prepare dados não sensíveis que façam o resultado fazer sentido. Não inclua um nome de cliente, um URL de cliente, um documento privado ou uma credencial na rota, no vídeo ou no README. Se a tarefa exigir autenticação, use uma conta de demonstração descartável através do processo aprovado. No GogoScreen, as credenciais são cifradas, utilizadas para uma única renderização e depois eliminadas. Se for planeado primeiro um storyboard, as credenciais ficam cifradas durante essa sessão e são eliminadas, no máximo, duas horas após a última utilização. As pessoas que preparam o ativo não devem pedi-las, copiá-las nem publicá-las.

Necessidade do leitor	Escolha da rota	Evidência a manter visível
Compreender o resultado do projeto	Comece perto da primeira tarefa reconhecível.	O contexto que explica a tarefa.
Inspecionar a mudança relevante	Use uma rota com uma ação de utilizador.	A ação e o estado de navegador resultante.
Decidir se explora mais	Termine no resultado selecionado.	O limite do que o ativo curto mostra.

O guia de vídeo demo de software a partir de um URL cobre a preparação de rota para uma demonstração baseada em navegador. O guia de vídeo de registo de alterações de agente de IA aplica a mesma evidência focada a uma alteração aceite. Ambas as abordagens só funcionam quando o estado inicial e o resultado são suficientemente claros para um leitor que nunca abriu a app.

Como deve a indicação descrever a tarefa do README?

Escreva a indicação na linguagem que um leitor vê na interface. Nomeie o ponto de partida, a ação e o resultado visível. Por exemplo, uma indicação pode pedir para abrir um espaço de trabalho preparado, concluir uma tarefa visível e mostrar o estado resultante. Não deve pedir para demonstrar todas as capacidades, explicar como o agente fez a interface, nem depender de termos que não aparecem na app.

Uma indicação direta cria uma sequência esperada para a pessoa que verifica o candidato. Se o candidato começar num sítio inesperado, parar num estado vazio ou alcançar um resultado diferente, o problema fica visível rapidamente. Isso torna o ativo do README mais fácil de rever do que um pedido amplo por um percurso completo do produto.

Teste a rota depois de escrever a indicação. O teste estabelece a sequência a inspecionar, não uma garantia de que a renderização vai funcionar. Se a tarefa depender de configuração escondida, prepare dados seguros ou selecione um caminho mais pequeno. O guia de demo de incidência do GitHub de agente de IA usa a mesma precisão quando um colega de equipa precisa de inspecionar uma tarefa delimitada. Um vídeo demo de agente de programação pode fornecer evidência de navegador relacionada quando a pergunta diz respeito a uma alteração técnica em vez de orientação de repositório.

O que deve o autor do README verificar?

Verifique se o candidato responde à pergunta pretendida sem depender apenas da narração. Veja-o primeiro sem som. O fotograma de abertura deve dar contexto suficiente para identificar a tarefa, a ação deve ser visível e o resultado não deve depender de uma explicação não dita. Depois compare a narração e as legendas com a sequência de ecrã. Uma descrição só é útil quando corresponde com precisão ao que aparece no ecrã.

Verifique também se há material inadequado para uma página de repositório. Procure dados privados, detalhes de clientes, trabalho incompleto, etiquetas enganadoras e ecrãs não relacionados. Um ficheiro concluído não é aprovação automática. Se o candidato precisar de um novo intento, registe se a rota, o estado preparado ou a indicação causaram o problema, e depois verifique a versão seguinte face à mesma tarefa.

Cada conta nova recebe 60 segundos de vídeo uma única vez, com marca de água. Depois disso, os vídeos usam tempo de um plano ou de um carregamento, e o tempo só é usado quando uma renderização é bem-sucedida. Estes limites do produto recompensam uma história de README concisa. Um leitor deve conseguir compreender o resultado do projeto numa única passagem, em vez de procurar numa gravação longa o momento que importa.

Onde pertence a demo num README?

Coloque a demo perto da explicação inicial do projeto, onde possa confirmar a frase que o leitor acabou de encontrar. Uma frase curta pode declarar a tarefa com que a app ajuda, e o vídeo pode mostrar a tarefa observada. Mantenha o material de instalação, configuração e desenvolvimento separado da explicação visual, para que os leitores escolham a profundidade que precisam.

Uma demo de repositório não precisa de fazer o trabalho de uma página de destino. O guia de demo de automação de navegador de agente de IA descreve como tornar uma sequência selecionada inspecionável. O guia de vídeo demo de SaaS ajuda a escolher uma tarefa relevante para o comprador quando a app tem várias histórias possíveis. O guia de vídeo demo de produto para README ajuda a avaliar quando um leitor de repositório precisa de vídeo em vez de um ativo curto. Para escolhas de gravação manual, GogoScreen versus Loom e GogoScreen versus Screen Studio comparam o esforço envolvido em preparar um fluxo de navegador focado.

Comece pela página inicial do GogoScreen para rever o fluxo de trabalho de URL e indicação. Veja os preços para os planos e carregamentos, e leia a política de privacidade antes de uma rota usar uma conta de demonstração. A decisão final pertence à pessoa que consegue confirmar que o texto do README, a tarefa visível e o vídeo candidato descrevem todos o mesmo resultado verificado.

Esclarecimentos

Antes de começar

O que deve mostrar uma demo README de agente de IA?

Mostre uma tarefa de navegador que ajude um leitor de repositório a compreender rapidamente o projeto. Estabeleça o contexto inicial, realize a ação relevante e mostre o resultado visível depois de uma pessoa ter verificado a rota e o candidato.

Uma demo README deve explicar como o agente fez a app?

Normalmente não. Um leitor do README precisa de compreender a app que consegue executar ou inspecionar. Mantenha o historial de implementação no registo de desenvolvimento e use a demo para mostrar um resultado observável no navegador.

Uma demo README pode usar uma rota atrás de um início de sessão?

Pode usar uma rota de demonstração preparada quando o fluxo precisar de autenticação. Não coloque credenciais no README nem no vídeo. A rota e o candidato continuam a precisar de uma verificação humana antes de serem partilhados.

Cole um URL, descreva um fluxo e obtenha um vídeo de demonstração da sua aplicação web.

Os primeiros 60 segundos de vídeo são gratuitos, com marca de água. Verifique o seu correio eletrónico para descarregar o vídeo.

Ver preços Ler os guias