Prompt de design para página inicial da documentação

Use este prompt de design para página inicial da documentação a fim de organizar primeiros passos, conceitos, guias de tarefas, referência da API e solução de problemas.

Conteúdo a preparar
Liste a primeira tarefa que um novo usuário deve concluir, os pré-requisitos, as versões compatíveis e os destinos reais da documentação. Separe os tutoriais do material de referência antes de criar a navegação.
Foco do design
Destaque a primeira tarefa bem-sucedida e preserve o contexto da versão.
Conceito visual gerado por IA para a página inicial da documentação
Página inicial da documentação
Conceito visual gerado por IA para a página inicial da documentação

Usar o prompt

Prompt
Adicione seu briefing

Adicione seu contexto abaixo. Ele será incluído no prompt quando você copiar ou baixar.

Crie um site HTML responsivo usando a stack existente do projeto para [PROJECT] e [AUDIENCE]. A tarefa é: Página inicial da documentação.

Conteúdo e estrutura obrigatórios

Organize primeiros passos, conceitos, guias de tarefas, referência da API e solução de problemas.

Use [APPROVED_CONTENT] como fonte de nomes, datas, números, alegações e destinos. Liste as informações ausentes antes de substituir qualquer conteúdo. Se for necessária uma demonstração, identifique o conteúdo como fictício. Não invente depoimentos de clientes, classificações, logotipos de parceiros ou recursos do produto.

Direção de design

Use [BRAND_RULES] e o sistema de design já selecionado no projeto. Se nenhum sistema tiver sido fornecido, comece com esta direção: marfim quente, tipografia em tom de carvão e um único destaque verde-ácido discreto; espaçamento generoso e uma grade assimétrica. Mantenha consistentes as funções da tipografia, do espaçamento e das cores. Priorize a tarefa em vez de elementos decorativos e evite uma coleção genérica de cartões sem relação entre si.

Preparação do conteúdo

Liste a primeira tarefa que um novo usuário deve concluir, os pré-requisitos, as versões compatíveis e os destinos reais da documentação. Separe os tutoriais do material de referência antes de criar a navegação.

Layout e comportamento

Dê um ponto de partida claro ao percurso de primeiros passos e organize os materiais mais aprofundados em torno de conceitos, tarefas e referência. Mantenha o contexto da versão visível quando o leitor sair da página inicial.

Verificação de aceitação específica da tarefa

  • Destaque a primeira tarefa bem-sucedida e preserve o contexto da versão.
  • Verifique se um novo usuário consegue escolher um guia inicial sem conhecer a terminologia interna.
  • Teste uma página renomeada, um resultado de busca ausente e um link específico de uma versão.

Implementação e revisão

Mantenha o texto editável. Use estrutura semântica, controles descritivos, foco de teclado visível e estados vazios/de erro adequados. Verifique layouts estreitos e amplos. Respeite as preferências de movimento reduzido. Preserve o framework e as dependências existentes do projeto; não substitua a stack silenciosamente. Entregue os arquivos editáveis e explique qualquer comportamento incompleto ou informação de entrada não compatível. Revise esta tarefa específica antes de propor recursos adicionais.

Anexo de referência e objetivo da reconstrução

Anexe o arquivo reference.webp do pacote de download deste prompt ao lado deste prompt no OpenDesign. Crie um resultado editável com composição e hierarquia semelhantes; não incorpore toda a imagem de referência como interface final. Preserve o conteúdo aprovado do projeto e as regras da marca caso entrem em conflito com rótulos fictícios de exemplo. Se a imagem estiver ausente ou ilegível, solicite-a em vez de alegar fidelidade visual.

Composição e conteúdo da referência

Use o arquivo reference.webp anexado como referência visual para a Página inicial da documentação. Antes de criar, identifique as principais regiões de cima para baixo, suas larguras e alturas relativas, alinhamento, espaçamento, hierarquia tipográfica, cores das superfícies, bordas, imagens e componentes repetidos. Preserve essas relações em vez de usar um modelo genérico. Conteúdo obrigatório da tarefa: organizar primeiros passos, conceitos, guias de tarefas, referência da API e solução de problemas. Ao traduzir a imagem em elementos editáveis, siga estas orientações específicas de layout: dê um ponto de partida claro ao percurso de primeiros passos e organize os materiais mais aprofundados em torno de conceitos, tarefas e referência. Mantenha o contexto da versão visível quando o leitor sair da página inicial.

Direção visual do briefing de exemplo

marfim quente, tipografia em tom de carvão e um único destaque verde-ácido discreto; espaçamento generoso e uma grade assimétrica.

Especificação de interação

A referência é um conceito estático: o comportamento abaixo é um requisito a ser implementado, não uma prova de que a imagem já funciona. Copie o prompt personalizado para seu projeto de trabalho. Comece pela tarefa principal: organizar primeiros passos, conceitos, guias de tarefas, referência da API e solução de problemas. Destaque a primeira tarefa bem-sucedida e preserve o contexto da versão. Para cada controle visível, especifique seu acionador, o estado afetado e o feedback; implemente alterações locais com um estado consistente entre as visualizações relacionadas. Faça com que a busca e os filtros apresentem resultados reais, que os controles de seleção tenham um estado ativo explícito e que as ações de salvamento mostrem feedback visível de andamento, sucesso ou falha, quando relevante. Não adicione fluxos de trabalho não relacionados. Use links adequados para navegação, botões para ações e nomes acessíveis nos controles de ícone. Não indique que uma operação de backend foi concluída se apenas uma demonstração local foi alterada.

Comparação visual e entrega

  1. Compare o resultado com a imagem anexada nas mesmas proporções. Revise o posicionamento das principais regiões, os tamanhos relativos das imagens, as quebras de linha, o espaçamento, a hierarquia tipográfica, o contraste, os estados ativos e a densidade do conteúdo antes de aperfeiçoar os detalhes decorativos.
  2. Em seguida, teste o layout estreito sem comprimir o texto da versão para desktop em rótulos minúsculos.
  3. Mantenha logotipos, fotos e ícones como arquivos separados e todos os rótulos relevantes editáveis. Liste fontes/arquivos indisponíveis e qualquer diferença intencional. Entregue os arquivos funcionais com uma descrição concisa do comportamento implementado e das integrações pendentes; não prometa um resultado idêntico pixel a pixel apenas com base no prompt.

Baixar prompt + imagem

Inclui o prompt completo e a imagem de referência em tamanho real. Anexe ambos no OpenDesign para orientar o layout.

Baixar arquivos

Como escrever um prompt de design para página inicial da documentação

Use este prompt de design para página inicial da documentação a fim de organizar primeiros passos, conceitos, guias de tarefas, referência da API e solução de problemas.

A referência é um conceito gerado por IA. As instruções abaixo descrevem o que criar e testar; a imagem não demonstra um comportamento funcional.

Separe os percursos de aprendizagem da consulta de referência

A documentação atende tanto às pessoas que estão aprendendo um conceito quanto às que procuram uma API específica.

Conceito visual gerado por IA para a página inicial da documentação
Página inicial da documentação — compare a hierarquia geral com as instruções de layout abaixo.

Misturar essas tarefas em uma grade de links sem diferenciação torna ambas mais lentas. Dê um ponto de partida claro ao percurso de primeiros passos e organize os materiais mais aprofundados em torno de conceitos, tarefas e referência. Mantenha o contexto da versão visível quando o leitor sair da página inicial.

Do prompt

Dê um ponto de partida claro ao percurso de primeiros passos e organize os materiais mais aprofundados em torno de conceitos, tarefas e referência.

Personalize

Agrupe primeiros passos, conceitos, guias de tarefas, referência da API e solução de problemas. Use [TASK_LABELS] nas descrições das entradas e preserve um caminho direto para o material de referência.

Prepare o conteúdo da página inicial da documentação

Cinco cartões separam introdução, conceitos, guias de tarefas, referência da API e solução de problemas. Prepare destinos distintos para essas intenções, em vez de direcionar todos os leitores para uma única página longa.

Pontos de entrada da documentação por intenção na referência da Página Inicial da Documentação
Pontos de entrada da documentação por intenção.

Liste a primeira tarefa que um novo usuário deve concluir, os pré-requisitos, as versões compatíveis e os destinos reais da documentação. Separe os tutoriais do material de referência antes de criar a navegação.

Do prompt

Organize primeiros passos, conceitos, guias de tarefas, referência da API e solução de problemas.

Personalize

Para [PROJECT], use [APPROVED_CONTENT] como fonte desta página inicial da documentação. Liste a primeira tarefa que um novo usuário deve concluir, os pré-requisitos, as versões compatíveis e os destinos reais da documentação. Separe os tutoriais do material de referência antes de criar a navegação. Identifique as informações ausentes antes de substituí-las por conteúdo de demonstração.

Siga o percurso de um iniciante e o de um especialista

A faixa de início rápido vai da criação de uma chave à realização de uma solicitação e à visualização do resultado. Verifique se o guia vinculado conclui essa sequência com um exemplo concreto.

Sequência da primeira tarefa concluída com sucesso na referência da Página Inicial da Documentação
Sequência da primeira tarefa concluída com sucesso.

Um percurso deve levar à primeira tarefa bem-sucedida; outro deve levar a uma entrada específica da API sem exigir uma nova leitura da introdução. Verifique se um novo usuário consegue escolher um guia inicial sem conhecer a terminologia interna. Teste uma página renomeada, um resultado de busca ausente e um link específico de uma versão.

Do prompt

Destaque a primeira tarefa bem-sucedida e preserve o contexto da versão.

Personalize

Revise a página inicial da documentação de acordo com este requisito: destaque a primeira tarefa bem-sucedida e preserve o contexto da versão. Verifique se um novo usuário consegue escolher um guia inicial sem conhecer a terminologia interna. Teste uma página renomeada, um resultado de busca ausente e um link específico de uma versão. Preserve o conteúdo aprovado e revise apenas as partes que não passarem nessa verificação.

Revise o resultado da página inicial da documentação

O texto, as rotas e a estrutura visual gerados precisam ser revisados. Não conecte formulários reais, pagamentos ou serviços externos sem implementar e testar esses fluxos.

  • Verifique se um novo usuário consegue escolher um guia inicial sem conhecer a terminologia interna. Teste uma página renomeada, um resultado de busca ausente e um link específico de uma versão.

Prompt de acompanhamento

Use isto após o primeiro resultado. Assim, a revisão se concentra na parte mais importante desta tarefa.

Aprimore a página inicial atual da documentação. Verifique se um novo usuário consegue escolher um guia inicial sem conhecer a terminologia interna. Teste uma página renomeada, um resultado de busca ausente e um link específico de uma versão. Preserve o conteúdo aprovado e a direção visual; altere apenas as partes necessárias para resolver esses problemas.

OpenDesign

Transforme seu prompt em um design.

Leve o prompt e a imagem de referência para o OpenDesign. Adicione seu conteúdo, crie a primeira versão e refine os detalhes.

Baixar OpenDesign ↓
Pintura em tons pastel de um lago azul, margens verdes e um céu ensolarado da página inicial do OpenDesign.