Documentação técnica
Publique manuais técnicos vivos no seu próprio domínio — um editor de blocos para redatores, GitHub Sync para engenheiros, busca para leitores, traduções com IA e um endpoint MCP para que os agentes de IA também leiam a sua documentação.
O que a documentação técnica realmente precisa
Uma boa documentação técnica não é uma pasta de arquivos nem um monte de PDFs: é um produto que os seus leitores usam para conseguir fazer algo. Seja escrevendo um guia de instalação, um manual de hardware, uma referência de SDK ou um runbook interno, são sempre as mesmas coisas que separam a documentação em que as pessoas confiam daquela que as pessoas abandonam. O software de documentação técnica existe para entregar essas coisas por padrão, para que a sua equipe dedique o tempo ao conteúdo e não ao encanamento.
Estrutura e navegação
Um manual técnico longo só é útil se o leitor conseguir encontrar a única seção de que precisa. Isso significa uma árvore de páginas de verdade, navegação ordenada e um layout que deixe clara a hierarquia. O OpenDocs é construído em torno de espaços estruturados com páginas aninhadas, então um manual de cinquenta páginas se lê como um todo coerente e não como um amontoado de documentos.
Verdade versionada
A documentação técnica fica desatualizada no momento em que o produto avança mais rápido do que ela. A solução é manter a documentação perto do código e sob controle de versão. Com o GitHub Sync, os seus manuais têm uma fonte de verdade versionada em um repositório: cada mudança é um commit, e a página publicada reflete o estado atual do produto, não um instantâneo de três versões atrás.
Publicação profissional e com marca própria
A documentação costuma ser a primeira interação séria que um desenvolvedor ou cliente tem com o seu produto. Ela deve parecer sua: seu domínio, suas cores, seu tema, sem um invólucro genérico em volta. Um software de documentação técnica criado para esse fim cuida da hospedagem, do SEO e da marca para que o manual se leia como uma parte de primeira linha do seu produto.
Capacidade de busca
Os leitores não folheiam os manuais técnicos; eles buscam. A busca integrada para leitores e o feedback por página transformam um manual estático em algo que os leitores podem consultar e melhorar. Quando uma página não está clara, o sinal de feedback diz à sua equipe exatamente qual seção corrigir.
Acesso para agentes de IA
Cada vez com mais frequência, o leitor não é uma pessoa. Os bots de suporte, os assistentes de programação e os agentes internos precisam ler a sua documentação para responder com precisão. Um software de documentação técnica moderno deve expor os seus manuais aos agentes de IA por uma interface estruturada, sem obrigá-los a fazer scraping do HTML nem a consumir uma exportação desatualizada. O OpenDocs faz isso com um servidor MCP integrado.
Como o OpenDocs cuida da documentação técnica
Cada capacidade corresponde a uma tarefa real do fluxo da escrita técnica — de redigir um manual a permitir que um agente de IA responda perguntas de suporte a partir dele.
Editor de blocos para redatores, GitHub Sync para engenheiros
Os redatores técnicos e os especialistas no assunto criam em um editor visual baseado em blocos, sem precisar saber Markdown nem git. Os engenheiros que vivem em um fluxo de docs-as-code editam Markdown em um repositório. O GitHub Sync mantém os dois sentidos alinhados: ao salvar uma página, gera-se um commit de Markdown com frontmatter YAML, e os pushes para o repositório atualizam as páginas, com detecção de conflitos quando os dois lados mudam a mesma página.
Portal com marca própria no seu domínio personalizado
Publique os seus manuais técnicos no seu próprio domínio com temas e cores personalizados. A sua documentação parece parte do seu produto, não um inquilino na plataforma de outra pessoa. O SEO integrado — meta tags, sitemap e URLs canônicas — torna a sua documentação localizável quando os engenheiros buscam como usar o seu produto.
Busca para leitores e feedback por página
Cada manual publicado inclui busca para leitores, para que as pessoas encontrem a seção exata de que precisam, e feedback por página, para que avisem quando um passo está errado ou faltando. Esse ciclo de feedback é o que mantém um manual técnico preciso ao longo do tempo, em vez de deixá-lo apodrecer em silêncio depois do lançamento.
Traduções com IA para manuais de vários mercados
Entregue o mesmo manual a cada mercado. As Traduções com IA mostram a sua documentação em até 38 idiomas e se mantêm sincronizadas quando você atualiza o original, então uma mudança no manual em inglês não deixa para trás a versão em português ou alemão. As traduções usam a sua própria chave de API da Anthropic (BYOK) e estão disponíveis em todos os planos.
Exportação em PDF para distribuição offline e regulada
Alguns manuais ainda precisam existir como arquivo: uma cópia offline para um técnico de campo, um artefato versionado para um auditor, um documento anexado a um registro de conformidade. A exportação em PDF (Enterprise) e em Markdown permite gerá-los sob demanda — sem transformar o PDF na sua fonte principal sempre desatualizada.
Servidor MCP para agentes de suporte e de programação
Cada espaço publicado é acessível pelo endpoint MCP do OpenDocs, protegido com uma chave de API. Os agentes de IA chamam ferramentas como list_spaces, get_page_tree, get_page e search_pages para ler os seus manuais como texto puro sobre HTTP em streaming. A sua documentação funciona também como uma fonte de conhecimento viva para os assistentes que a sua equipe e os seus clientes já usam.
Manuais técnicos sem o cemitério de PDFs
Quase toda equipe tem um: um drive compartilhado cheio de manuais técnicos em PDF, cada um com um número de versão em que ninguém confia, cada um um pouco desatualizado, cada um impossível de buscar em conjunto. O PDF parecia seguro porque era um arquivo autocontido, mas essa mesma propriedade é a razão pela qual ele apodrece. Assim que um manual vira PDF, atualizá-lo significa reexportar, reenviar e redistribuir, então na prática quase nunca é atualizado. Os leitores acabam seguindo instruções para um produto que já não funciona mais assim.
Um manual web vivo inverte essa lógica. A sua documentação técnica vive como páginas estruturadas que qualquer pessoa da equipe pode corrigir em minutos, que os leitores podem buscar e que sempre refletem a versão atual. Como o conteúdo está sob controle de versão pelo GitHub Sync, você continua tendo a rastreabilidade que fazia os PDFs parecerem confiáveis — cada mudança é um commit — sem congelar o manual no tempo. E quando um leitor sinaliza um passo quebrado pelo feedback por página, a correção é uma edição rápida, não um projeto de gestão documental.
Nada disso significa abrir mão dos arquivos por completo. Quando você realmente precisa de uma cópia offline ou portátil — um técnico trabalhando sem conectividade, um regulador que quer um documento fixo, um cliente que exige uma versão assinada — a exportação em PDF do plano Enterprise gera uma a partir da mesma fonte. A diferença está na direção da autoridade: o manual web é a fonte de verdade, e o PDF é um instantâneo que você produz quando precisa, em vez da cópia mestra de que todos desconfiam em silêncio.
Preços fixos e simples para equipes de documentação
O OpenDocs usa níveis fixos com membros incluídos, então uma equipe de documentação em crescimento não significa uma fatura por assento em crescimento. O Pro custa $55 por mês (ou $45.65 por mês na cobrança anual, o que equivale a $547.80/ano) e inclui 5 membros, com $5 por usuário adicional ao mês na cobrança mensal ou $4 por usuário adicional no anual. O Pro cobre todo o kit de publicação: domínio personalizado, temas personalizados, o editor de blocos, GitHub Sync, busca para leitores, feedback por página, Traduções com IA e o servidor MCP.
O Enterprise custa $99 por mês (ou $82.50 por mês na cobrança anual, $990/ano) e inclui 10 membros. Ele adiciona as peças que as equipes reguladas e maiores costumam precisar: análises e insights, exportação em PDF, exportação em Markdown, acesso à API com documentação completa da API, sem o selo "Powered by", SSO/SAML, registros de auditoria e suporte prioritário. E algo essencial: os leitores dos seus manuais publicados nunca são cobrados como assentos — o acesso é controlado no nível do espaço, seja a documentação pública ou restrita.
Você pode avaliar tudo primeiro. O teste gratuito de 14 dias não exige cartão de crédito e libera todas as funções do Pro, para que você construa um manual real antes de decidir. (A publicação em domínio personalizado é ativada quando você faz upgrade do seu plano.)
Perguntas frequentes
O que é um software de documentação técnica?
O software de documentação técnica é uma plataforma criada especificamente para redigir, estruturar e publicar manuais técnicos, documentação de produto, referências de API e guias internos de engenharia. Diferente de um processador de texto ou de um wiki genérico, ele cuida da navegação, do conteúdo versionado, da busca para leitores e da publicação com marca própria, para que a sua documentação seja lida como um produto coerente e mantido. O OpenDocs é uma plataforma SaaS de documentação técnica: os redatores usam um editor visual de blocos, os engenheiros podem sincronizar pelo GitHub e a sua documentação é publicada no seu próprio domínio.
Preciso saber Markdown ou git para escrever documentação técnica no OpenDocs?
Não. O OpenDocs usa um editor visual baseado em blocos, então os especialistas no assunto e os redatores técnicos podem criar manuais sem tocar em Markdown nem em git. Os engenheiros que preferem um fluxo de docs-as-code podem continuar trabalhando em Markdown pelo GitHub Sync, e os dois lados se mantêm sincronizados automaticamente. Você escolhe o fluxo de trabalho que combina com cada pessoa.
Como o OpenDocs mantém os manuais técnicos precisos e versionados?
O GitHub Sync dá à sua documentação uma fonte de verdade versionada. Ao salvar uma página, gera-se um commit de Markdown com frontmatter YAML de volta a um repositório do GitHub, e os pushes para esse repositório atualizam as suas páginas. A detecção de conflitos sinaliza tudo o que mudou dos dois lados e mostra uma comparação lado a lado, então o manual que os seus leitores veem reflete o estado atual do produto e não uma exportação desatualizada.
Os agentes de IA podem ler a minha documentação técnica publicada?
Sim. Cada espaço publicado fica disponível pelo servidor MCP (Model Context Protocol) do OpenDocs, protegido com uma chave de API do OpenDocs. Os clientes compatíveis com MCP, como o Claude Desktop e o Claude Code, podem chamar ferramentas como search_pages e get_page para consultar os seus manuais diretamente como texto puro. A sua documentação vira uma fonte de conhecimento viva e consultável para agentes de suporte e de programação, sem scraping nem exportações desatualizadas.
Posso exportar manuais técnicos em PDF para distribuição offline ou regulada?
Sim. A exportação em PDF está disponível no plano Enterprise, junto com a exportação em Markdown e o acesso completo à API. A sua documentação vive como um manual web com busca para o uso diário, e você pode gerar um PDF quando realmente precisa de uma cópia offline, de um artefato versionado para auditores ou de um documento para anexar a um registro de conformidade.
Quanto custa o OpenDocs para uma equipe de documentação?
O Pro custa $55 por mês de forma fixa (ou $45.65 por mês na cobrança anual) e inclui 5 membros, com $5 por usuário adicional ao mês no mensal ou $4 por usuário adicional no anual. O Enterprise custa $99 por mês e inclui 10 membros, além de análises, exportação em PDF e Markdown, acesso à API, SSO/SAML e registros de auditoria. Os leitores dos seus manuais publicados nunca são cobrados como assentos. O teste gratuito de 14 dias com todas as funções do Pro não exige cartão de crédito.