Casos de uso do Docsbook: os trabalhos para os quais as equipes contratam documentação

Seis situações com as quais as equipes chegam e o que o Docsbook faz em cada uma delas. Todas terminam com o guia que realiza o trabalho, para que você possa começar pela situação, em vez de por uma lista de recursos.

"Quero que o ChatGPT nos recomende quando um cliente perguntar"#

A situação. Você tem um produto, clientes e um orçamento para anúncios. Alguém pergunta a um assistente de IA qual ferramenta faz o que você faz, e sua empresa não aparece na resposta.

O que impede isso. Um assistente recomenda o que consegue ler e verificar com facilidade: o que o produto faz, quanto custa, quais são seus limites e quem está por trás dele. Se isso não estiver escrito em algum lugar que ele possa acessar, ele cita um concorrente que escreveu sobre isso.

O que o Docsbook faz. O Docsbook publica suas páginas como HTML renderizado no servidor, para que um rastreador veja o texto sem executar JavaScript, e adiciona os elementos que os assistentes procuram: sitemap.xml, URLs canônicas, JSON-LD, uma data visível da última modificação e llms.txt na raiz do site. Cada página recebe sua própria URL e seu próprio título, para que uma página sobre uma pergunta específica concorra nessa pergunta.

Comece por: GEO — otimização para mecanismos generativos, depois llms.txt.

"Nossa documentação recebe tráfego e não consigo saber se isso gera vendas"#

A situação. O Analytics diz que a documentação é lida. Ninguém consegue dizer se a leitura levou alguém a se cadastrar ou quais páginas desperdiçam a visita.

O que impede isso. As visualizações de página não descrevem um caminho. Sem eventos e um objetivo definido, um site de documentação relata popularidade, não progresso.

O que o Docsbook faz. O Docsbook registra visualizações de página, pesquisas, tempo de leitura, votos de feedback e eventos monitorados em cada página, depois os relata como caminhos: quais páginas ninguém acessa, quais pesquisas não retornam resultados, até onde um leitor chega antes de sair e de quais países e idiomas eles vêm. Marque uma página como uma etapa do funil e conte quantos leitores concluem o processo.

Comece por: Visão geral do monitoramento e, em seguida, Eventos.

"Nossa documentação está três meses atrasada em relação ao produto"#

A situação. O produto recebeu alterações. A documentação ainda descreve o comportamento antigo, e todos sabem disso.

O que impede isso. A documentação que fica fora do repositório exige um esforço separado de lembrança. Uma etapa de compilação e implantação entre escrever e publicar transforma uma correção de cinco minutos em uma tarefa que ninguém começa.

O que o Docsbook faz. O Docsbook disponibiliza o Markdown que está no seu repositório. Ele verifica novamente o GitHub quando o site é visitado e reindexa o que mudou, então um push é a publicação — não há etapa de compilação, pipeline de CI nem implantação para esperar. As edições também podem vir do editor web ou de um agente via MCP, e as três opções resultam em commits no mesmo repositório.

Comece por: Conectar um repositório do GitHub e, em seguida, Gerenciar sua documentação.

"Nossos clientes não leem inglês"#

A situação. Você vende em mercados onde o idioma da sua documentação não é aquele em que seus clientes fazem buscas. Traduzir manualmente significa que as traduções ficam desatualizadas assim que o inglês muda.

O que impede isso. Uma tradução só vale a pena ser publicada se permanecer alinhada ao original e for indexada como uma página própria. Uma cópia colada em uma pasta não é nenhuma das duas coisas.

O que o Docsbook faz. O Docsbook traduz suas páginas para 15 idiomas — inglês, espanhol, francês, alemão, português, italiano, russo, chinês, japonês, coreano, árabe, hindi, turco, polonês e holandês. Cada idioma é disponibilizado em sua própria rota com as tags hreflang corretas, para que os mecanismos de busca o indexem separadamente e os leitores acessem o idioma do navegador. A tradução é um trabalho de IA, portanto utiliza o saldo do projeto.

Comece com: Ative a tradução e, em seguida, Traduções com IA.

"O suporte responde às mesmas cinco perguntas todas as semanas"#

A situação. As respostas existem na documentação. Mesmo assim, os leitores abrem um chamado porque não encontraram a página.

O que impede isso. A pesquisa que corresponde a palavras-chave literais não consegue acompanhar a forma como as pessoas realmente perguntam. Um leitor que formula uma pergunta de maneira diferente do seu título não encontra nada e procura ajuda humana.

O que o Docsbook faz. O assistente de IA do Docsbook responde com base nas suas páginas indexadas e cita a página da qual obteve a resposta, para que um leitor que teria aberto um chamado receba a resposta onde está. O que ele não conseguiu responder fica registrado: perguntas sem resposta e pesquisas que não retornaram nada são listadas para você, indicando qual página escrever em seguida. As respostas do assistente são geradas por IA e consomem o saldo do projeto.

Comece por: Chat de IA e depois Feedback da página.

"Temos um README e ninguém tem tempo para criar um site de documentação"#

A situação. A documentação do projeto é um longo README.md, além de uma pasta docs/ que ninguém publicou. Configurar um gerador de site estático é um trabalho de uma semana que você não terá tempo para fazer.

O que impede isso. Um gerador precisa de uma configuração, um tema, um pipeline de build e uma decisão sobre hospedagem antes de renderizar uma única página — e então alguém precisa manter os quatro.

O que o Docsbook faz. O Docsbook lê o repositório como ele é. A estrutura de pastas se torna a árvore de navegação, os títulos se tornam o sumário, os links .md relativos são resolvidos para URLs reais e o site fica disponível em docsbook.io/{owner}/{repo} com pesquisa de texto completo e uma URL pública. Não há nenhum arquivo de configuração para escrever. Seu Markdown nunca sai do seu repositório do GitHub, então apontar outra ferramenta para o mesmo repositório mais tarde não custa nada.

Comece com: Início rápido e, em seguida, Crie seu primeiro site.

Próximos passos#

• Visão geral — o que o Docsbook faz com seu repositório, de ponta a ponta
• Conceitos — os termos usados acima, definidos uma única vez
• Preços — o que é medido e pelo que o saldo de um projeto paga
• FAQ — cancelamento, privacidade, sincronização e propriedade dos dados