Documentation Index

Fetch the complete documentation index at: https://docs.document360.com/llms.txt

Use this file to discover all available pages before exploring further.

Isenção de responsabilidade: Este artigo foi gerado usando tradução automática.

Definindo seu público

Prev Next

Cada decisão documental — o que incluir, quanto explicar, quais palavras usar — surge de uma única fonte: uma compreensão clara de para quem você está escrevendo. Sem isso, você está apenas adivinhando. Com ele, você tem um filtro confiável para cada escolha que faz.

Seu público hoje é mais amplo do que costumava ser. Ainda inclui o leitor humano tentando fazer algo, mas agora também inclui mecanismos de busca, mecanismos de resposta e assistentes de IA que leem sua documentação em nome dessa pessoa — e às vezes entregam uma resposta sem nunca enviá-la para o artigo. Uma definição completa de audiência considera ambos.

Este artigo explica como identificar e descrever seu público, e como usar esse entendimento para escrever documentação que seja genuinamente útil para as pessoas — e sistemas — que precisam dela.

Por que a Definição de Público Importa

O mesmo tema pode ser documentado de maneiras completamente diferentes, dependendo de quem está lendo. Um artigo sobre configurar permissões de usuário, por exemplo, parece muito diferente quando escrito para um administrador de sistema em comparação com um usuário de primeira viagem. O administrador precisa de precisão e casos extremos. O usuário de primeira viagem precisa de contexto, tranquilidade e passos claros.

Escrever para "todos" quase sempre significa escrever para ninguém, bem. Quando você tenta atender a todos os leitores possíveis em um único artigo, acaba sobrecarregando iniciantes com detalhes ou entediante com especialistas com explicações que eles não precisam.

Como Descrever Seu Público

Uma descrição útil do público responde a quatro perguntas.

O que seu leitor já sabe?

Identifique o conhecimento básico que seu leitor traz para o artigo. Isso determina o quanto você precisa explicar e quais termos pode usar sem definição.

Um leitor sem conhecimento em sua área precisa de termos definidos, conceitos introduzidos e etapas detalhadas detalhadamente. Um leitor que trabalha diariamente no campo não precisa de nada disso — ele precisa de informações precisas e eficientes que respeitem sua expertise.

Seja específico. "Usuários técnicos" não é útil. "Desenvolvedores de software familiarizados com APIs REST, mas novos em fluxos de autenticação" é.

O que seu leitor está tentando alcançar?

Os leitores chegam à documentação com um objetivo. Eles querem completar uma tarefa, resolver um problema ou entender um conceito. Entender o objetivo deles diz quais informações devem estar no artigo e o que é ruído.

Pergunte: como é o sucesso para este leitor? Quando eles encerram este artigo, o que devem ser capazes de fazer que não podiam fazer antes?

Em que contexto seu leitor está?

O contexto molda a forma como os leitores leem. Um leitor que está no meio de uma sessão frustrada de solução de problemas lê diferente de alguém que explora um recurso por curiosidade. Um leitor em um dispositivo móvel em uma reunião lê de forma diferente de alguém em uma mesa com dois monitores.

O contexto mostra quanta paciência seu leitor tem, quantos detalhes ele consegue absorver e o quanto precisa urgentemente de uma resposta.

O que seu leitor não sabe que precisa saber?

Essa é frequentemente a pergunta mais importante e a mais difícil de responder. As lacunas no conhecimento do leitor nem sempre são evidentes — especialmente quando você é especialista no assunto. Essa é a "maldição do conhecimento": quanto mais você sabe sobre algo, mais difícil é lembrar como era não saber disso.

Combata isso envolvendo leitores reais no seu processo de documentação. Testes com usuários, análise de tickets de suporte e conversas diretas com clientes são todas formas eficazes de descobrir o que as pessoas realmente não sabem.

Níveis de Audiência por Especialização

A maioria das bases de conhecimento atende a mais de um público. Um padrão comum é ter três grupos de leitores distintos, cada um exigindo uma abordagem diferente.

Iniciantes

Iniciantes não conhecem o produto, o domínio ou ambos. Eles precisam de orientação antes da instrução. Eles se beneficiam de visões conceituais que explicam o que é algo antes de explicar como usá-lo. Eles precisam de pré-requisitos detalhados, passos numerados claramente e resultados explicitamente declarados para que saibam quando tiveram sucesso.

Iniciantes são facilmente desencorajados por jargões inexplicáveis, passos que pulam adiante ou artigos que assumem contexto que não têm. Toda suposição inexplicada é um possível ponto de saída.

Usuários intermediários

Usuários intermediários conhecem o básico e estão expandindo o uso do produto. Eles não precisam de acompanhamento, mas precisam de informações completas. Eles costumam ser o maior grupo em uma base de conhecimento e os mais difíceis de escrever para eles, pois suas necessidades são as mais variadas.

Usuários intermediários se beneficiam de conteúdo claro e direto focado em tarefas, que vai direto ao ponto rapidamente e fornece contexto suficiente para entender o porquê de cada etapa.

Usuários avançados

Usuários avançados — administradores, desenvolvedores, usuários avançados — conhecem profundamente o produto e precisam de informações precisas e detalhadas. Eles frequentemente exploram casos extremos, integram-se com outros sistemas ou resolvem problemas complexos.

Usuários avançados ficam frustrados com explicações excessivas e preâmbulos desnecessários. Eles querem precisão técnica, referências completas de parâmetros e reconhecimento honesto das limitações. Eles toleram densidade se isso significar precisão.

Níveis de Audiência por Visibilidade

Além da expertise, o público também varia conforme quem pode ver o conteúdo. Isso afeta não apenas o tom, mas a estrutura, a profundidade e se a descoberta de busca e IA sequer se aplicam.

Documentação pública

Documentação pública está disponível para qualquer pessoa, inclusive para pessoas que ainda não são clientes. Precisa funcionar para leitores que chegam sem nenhum contexto, e precisa ser descobrível — o que significa que SEO, AEO e GEO se aplicam diretamente:

  • SEO: o artigo precisa ranquear para os termos que um usuário potencial ou existente buscaria.
  • AEO: o artigo precisa de uma resposta clara e extraível perto do topo, pois pode ser mostrado como um trecho ou lido em voz alta por um assistente de voz antes mesmo do leitor clicar.
  • GEO: o artigo precisa ser estruturado para que um assistente de IA possa recuperá-lo e citá-lo com precisão quando um usuário faz a mesma pergunta a um chatbot de uso geral.

O conteúdo público deve assumir a maior variedade possível de conhecimento prévio e nunca deve depender de terminologia interna.

Documentação privada (interna)

A documentação privada é restrita a funcionários, parceiros ou a um público interno definido. Ele pode assumir com segurança contexto compartilhado, vocabulário interno e treinamento prévio — o que permite que seja mais denso e eficiente. A descoberta aqui é sobre busca interna, não sobre mecanismos de busca públicos: SEO e GEO para sistemas públicos de IA são irrelevantes, mas assistentes internos de IA (se sua organização os usar) ainda se beneficiam da mesma estrutura clara e terminologia consistente que ajuda a geo pública.

A documentação privada pode pular a orientação que o conteúdo público precisa, mas não deve perder precisão — um público interno sob pressão de tempo ainda é um público que precisa ter sucesso na primeira leitura.

Documentação para público misto

Alguns conteúdos — páginas de preços, visões gerais de segurança, guias de integração — são escritos para um público misto: parte público, parte cliente autenticado, às vezes parte interno. Este é o nível mais difícil de escrever, porque o mesmo artigo pode precisar satisfazer um cliente em potencial pesquisando o produto, um cliente existente configurando-o e um agente de suporte para resolver problemas.

Para públicos mistos, comece com o que o grupo mais amplo precisa (geralmente o público "o que é isso e por que eu usaria") e adicione detalhes progressivamente mais específicos para os grupos mais restritos, em vez de tentar fazer uma média do conteúdo para algo vago demais para qualquer um.

Escrevendo para Múltiplos Públicos

Quando um único artigo precisa atender a mais de um público, estruture-o para que cada grupo — humano ou IA — possa encontrar o que precisa sem ter que navegar por conteúdos que não são para eles.

Uma abordagem eficaz é começar com as informações essenciais que todos os leitores precisam e depois adicionar informações progressivamente mais detalhadas. Iniciantes param quando têm o que precisam; Usuários avançados continuam com os detalhes. Essa camada também é exatamente o que beneficia o AEO e o GEO: uma resposta clara no início para extração, e detalhes de apoio abaixo para os leitores que desejam.

Outra abordagem é separar totalmente o conteúdo: manter uma versão voltada para iniciantes e uma versão avançada do mesmo tema. Isso custa mais para manter, mas produz resultados mais satisfatórios para ambos os públicos.

O que não funciona é tentar atender a todos os públicos em um único bloco de texto indiferenciado. Quando todos são o público, ninguém é — e um sistema de IA resumindo um artigo indiferenciado tem a mesma chance de produzir uma resposta indiferenciada e pouco útil.

Não Esqueça do Leitor de IA

Cada vez mais, uma parcela real do seu público nunca lê o artigo diretamente. Eles fazem uma pergunta a um motor de busca, a um assistente de IA ou a um chatbot dentro do produto, e esse sistema lê sua documentação, extrai uma resposta e a apresenta em seu nome. Esse "leitor" tem suas próprias características que valem a pena ser projetado:

  • Não tem paciência para pistas enterradas — precisa da resposta perto do início do artigo, claramente declarada.
  • Não tolera ambiguidade — pronomes vagos, suposições não declaradas e terminologia inconsistente aumentam as chances de um resumo errado ou distorcido.
  • Não pode fazer uma pergunta de acompanhamento como um humano pode — então a completude dentro de uma única seção importa mais, não menos.

Projetar para esse público não entra em conflito com o design para leitores humanos — as práticas que tornam um artigo claro e bem estruturado para uma pessoa (uma resposta direta no início, uma ideia por seção, termos consistentes) são as mesmas práticas que facilitam a recuperação e citação corretas por um sistema de IA.

Documentando as Decisões do Seu Público

Definições de audiência só são úteis se forem compartilhadas. Anote quem é seu público principal para cada seção ou tipo de conteúdo na sua base de conhecimento — incluindo seu nível de especialização, seu nível de visibilidade (público, privado ou misto) e se ele precisa ser otimizado para descoberta pública — e torne essa definição disponível para todos que contribuem. Quando um novo escritor entra, ele deve ser capaz de ler a definição do público e entender imediatamente para quem está escrevendo.

Revise as definições do público periodicamente. À medida que seu produto cresce e sua base de usuários muda, as pessoas — e os sistemas — que leem sua documentação também mudam.