Portal do desenvolvedor
O OpenDocs é software de portal do desenvolvedor — guias, referência e changelogs publicados no seu próprio domínio, em sincronização bidirecional com o GitHub e consultáveis ao vivo pelos assistentes de IA de programação por meio de um servidor MCP.
O que os desenvolvedores esperam de um portal
Um portal do desenvolvedor é a porta de entrada ao seu produto para quem constrói sobre ele. Quando um desenvolvedor chega, ele não está passeando — tem uma tarefa a resolver, e o portal ou o ajuda a concluí-la ou o manda para a documentação de um concorrente. Essa é uma régua alta, e é uma régua diferente da que uma base de conhecimento geral ou uma wiki interna precisa alcançar.
A primeira coisa que os desenvolvedores esperam é a mistura certa de conteúdo. Os guias e tutoriais os levam do zero a uma primeira chamada funcional. A referência documenta cada endpoint, parâmetro e método do SDK com precisão, porque é à referência que eles voltam cem vezes depois do onboarding. Um changelog diz a eles o que mudou e o que quebrou entre versões. Um portal com guias mas sem referência, ou com referência mas sem um caminho de início, deixa metade da audiência travada.
Segundo, os desenvolvedores esperam que a documentação viva junto ao código. A referência escrita à mão em uma ferramenta separada fica desatualizada no momento em que um engenheiro publica uma mudança. A documentação que se mantém precisa é a que os engenheiros podem editar no mesmo pull request do código, em Markdown, sob controle de versões — enquanto os redatores continuam com um editor amigável para polir os guias ao redor dela.
Terceiro, os desenvolvedores esperam busca rápida. Ninguém lê um portal do desenvolvedor do começo ao fim. Eles chegam a partir de um buscador ou de um link interno, usam a busca do próprio portal e esperam estar na página certa em segundos. Uma busca lenta ou ausente é a forma mais rápida de perdê-los.
E cada vez mais, os desenvolvedores esperam que seus assistentes de IA de programação também consultem a documentação. Uma parcela crescente do trabalho de desenvolvimento acontece com um assistente aberto no editor. Se esse assistente puder ler sua documentação ao vivo em vez de adivinhar a partir de uma cópia de treinamento, suas respostas coincidem com o funcionamento atual do seu produto. Um portal do desenvolvedor moderno precisa atender as pessoas e seus agentes a partir da mesma fonte.
Como o OpenDocs constrói esse portal
Cada recurso responde a algo que os desenvolvedores esperam — documentação junto ao código, um hub com marca própria, busca ao vivo e, agora, docs que a IA deles pode ler.
Sincronização bidirecional com o GitHub
Conecte um espaço a um repositório do GitHub com um Personal Access Token e as edições fluem nos dois sentidos. Um push atualiza suas páginas por meio de um webhook; salvar uma página faz commit de Markdown mais frontmatter YAML de volta ao repositório. Os engenheiros mantêm a referência no repositório junto ao código, os redatores polem os guias no editor visual, e a detecção de conflitos mostra uma comparação lado a lado quando ambas as partes tocam na mesma página. É um fluxo docs-as-code de verdade sem obrigar seus redatores a usar git.
Um portal com marca própria no seu domínio
Publique todo o hub no seu próprio domínio personalizado com suas cores e tema, navegação estruturada e sem subdomínio genérico. O SEO integrado — metatags, sitemap e URLs canônicas — torna seus guias e referência visíveis para os buscadores dos quais os desenvolvedores realmente partem. O portal parece parte do seu produto porque é.
Busca para leitores integrada
Cada portal publicado inclui busca para leitores, então um desenvolvedor que chega no meio do site encontra a página exata de que precisa sem sair dele. O feedback de página permite aos leitores avisar você quando um doc não acertou o alvo, para que as lacunas do seu portal venham à tona a partir de quem o usa.
Acesso à API e docs de API completa no Enterprise
O plano Enterprise adiciona acesso à API e documentação de API completa, junto com analytics e insights, exportação PDF e Markdown, SSO/SAML, logs de auditoria e suporte prioritário — as peças que uma equipe grande voltada a desenvolvedores precisa para operar um portal em escala e ver como ele é usado.
O destaque: docs que seus assistentes de IA de programação podem consultar ao vivo
Aqui é onde um portal do desenvolvedor no OpenDocs faz algo que a maioria dos portais não consegue. Cada espaço que você publica é acessível através do servidor MCP do OpenDocs — um endpoint construído sobre o Model Context Protocol, o padrão aberto para conectar assistentes de IA a ferramentas e dados reais. Proteja-o com uma chave de API do OpenDocs, aponte um assistente do tipo Claude Code ou Cursor para ele e sua documentação se torna uma fonte de dados viva e estruturada que o assistente pode ler enquanto um desenvolvedor constrói.
O servidor expõe quatro ferramentas. list_spaces informa a um agente quais conjuntos de documentação ele pode alcançar. get_page_tree devolve a estrutura de navegação completa de um espaço para que o agente saiba onde cada coisa está. get_page devolve o conteúdo completo de uma página como texto puro e limpo. search_pages executa uma busca por palavras-chave em um espaço. Juntas, elas permitem que um assistente descubra, navegue, leia e busque no seu portal do mesmo jeito que um desenvolvedor faria — mas em velocidade de máquina, no meio de uma sessão de programação.
Como ele lê seu conteúdo publicado ao vivo sobre o transporte HTTP com streaming, não há nada para exportar nem um scraper para cuidar. No instante em que você publica uma mudança, a consulta seguinte a reflete, então um assistente responde a partir dos seus guias de API atuais e não de uma cópia anterior ao seu último lançamento. Funciona com qualquer cliente compatível com MCP — Claude Desktop, Claude Code e um ecossistema crescente de outros clientes MCP — e o acesso é governado por completo pela chave de API que você emite, que pode ser rotacionada para deixar de atender um agente a qualquer momento. Sua documentação publicada funciona também como uma fonte de conhecimento consultável para agentes de IA, sem um pipeline separado para manter.
Com honestidade: não há um console interativo para testar a API
Preferimos definir a expectativa certa a exagerar. O OpenDocs não inclui um explorador interativo de API — aquele tipo de console OpenAPI executável que dispara requisições ao vivo de dentro da documentação e mostra a resposta a você. Se esse playground executável é o centro do que o seu portal precisa, as ferramentas construídas em torno de OpenAPI o atendem melhor do que nós, e nós apontamos elas para você: o ReadMe é API-first com um explorador interativo, e o Mintlify é docs-as-code com forte instrumentação de referência de API.
Para o que o OpenDocs foi construído é para o portal ao redor da sua API: os guias que a ensinam, os tutoriais que a mostram em contexto, os docs do SDK, os conceitos, o changelog e as páginas de referência, tudo em um site com marca própria e com busca que engenheiros e redatores mantêm juntos — e que os assistentes de IA podem consultar por meio de MCP. Para a maioria das equipes essa é a metade maior e mais difícil de um portal do desenvolvedor, e é a metade que o OpenDocs faz excepcionalmente bem. Muitas equipes combinam um console de API dedicado com o OpenDocs para todo o resto; um link do seu portal para um explorador hospedado é uma ponte pequena de construir.
Documentação para desenvolvedores em espanhol e português
Alcance audiências de desenvolvedores na América Latina e no mundo sem montar um projeto de localização à parte.
Até 38 idiomas
As Traduções com IA exibem todo o seu portal — guias, referência e changelog — em até 38 idiomas, incluindo espanhol e português para as comunidades de desenvolvedores em rápido crescimento da América Latina e do Brasil.
Permanece sincronizada com o original
As traduções seguem o original. Quando você atualiza uma página em inglês, as versões traduzidas se mantêm em dia, então um desenvolvedor em espanhol ou português nunca lê uma cópia desatualizada enquanto a versão em inglês já avançou.
Use sua própria chave de API
As traduções usam sua própria chave de API da Anthropic (BYOK), então o consumo de IA é cobrado diretamente na sua conta da Anthropic e não com sobretaxa do OpenDocs. Está disponível em todos os planos, incluindo o teste gratuito.
Preços que não penalizam seus leitores
Um portal do desenvolvedor é lido por muito mais pessoas do que o editam, e o preço do OpenDocs foi pensado para isso. Os níveis são fixos, com membros incluídos, e os desenvolvedores e clientes que leem seu portal publicado nunca são cobrados como assentos — o acesso de leitores é controlado pelo espaço (público, ou restrito para docs privadas), não por uma licença por assento.
O Pro custa $55/mês (ou $45.65/mês na cobrança anual, $547.80/ano) e inclui 5 membros, com membros adicionais a $5/membro/mês na cobrança mensal ou $4/membro/mês na anual. O Enterprise custa $99/mês (ou $82.50/mês na cobrança anual, $990/ano) e inclui 10 membros, e adiciona acesso à API, docs de API completa, analytics e insights, exportação PDF e Markdown, SSO/SAML, logs de auditoria e suporte prioritário. Todos os planos — incluindo o teste gratuito — incluem o GitHub Sync, o servidor MCP e os recursos de IA. O teste gratuito de 14 dias não exige cartão de crédito e desbloqueia todos os recursos do Pro para que você construa um portal real antes de decidir. Consulte a página de preços completa para o detalhamento.
Perguntas frequentes
O que é um portal do desenvolvedor?
Um portal do desenvolvedor é o lugar único ao qual seus desenvolvedores vão para entender e usar o seu produto: guias de onboarding, tutoriais, referência de API e SDK, conceitos e um changelog, tudo em um site com marca própria e com busca. O OpenDocs é software de portal do desenvolvedor que publica esse hub no seu próprio domínio, o mantém em sincronização bidirecional com um repositório do GitHub e o expõe aos assistentes de IA de programação por meio de um servidor MCP.
O OpenDocs tem um console interativo para testar a API?
Não. O OpenDocs não inclui um explorador interativo de API que envie requisições ao vivo a partir da documentação. Ele é o portal ao redor dos seus guias, tutoriais, docs de SDK e conceitos, com páginas de referência de API completa no Enterprise. Se um console executável de OpenAPI é o centro do que você precisa, ferramentas como o ReadMe ou o Mintlify foram construídas para isso, e dizemos isso com honestidade.
Como engenheiros e redatores trabalham na mesma documentação?
O GitHub Sync mantém um espaço e um repositório sincronizados nas duas direções. Os engenheiros editam Markdown no repositório junto ao código; os redatores usam o editor visual por blocos sem precisar saber git. Um push atualiza as páginas por meio de um webhook, salvar uma página faz commit de Markdown mais frontmatter YAML de volta ao repositório, e a detecção de conflitos mostra uma comparação lado a lado quando ambas as partes mudam a mesma página.
Os assistentes de IA de programação conseguem ler a minha documentação?
Sim. Cada espaço publicado é acessível através do servidor MCP do OpenDocs, protegido com uma chave de API. Clientes compatíveis com MCP como o Claude Desktop e o Claude Code podem chamar list_spaces, get_page_tree, get_page e search_pages para listar, ler e buscar sua documentação ao vivo no momento da consulta, então um assistente responde a partir da sua documentação atual e não de uma cópia desatualizada.
Posso publicar documentação para desenvolvedores em mais de um idioma?
Sim. As Traduções com IA exibem sua documentação em até 38 idiomas, incluindo espanhol e português para audiências de desenvolvedores na América Latina. As traduções usam sua própria chave de API da Anthropic (BYOK) e permanecem sincronizadas quando você atualiza o original, então um leitor em espanhol ou português vê o mesmo conteúdo atual da versão original.
Quanto custa um portal do desenvolvedor no OpenDocs?
O OpenDocs usa níveis fixos com membros incluídos. O Pro custa $55/mês (ou $45.65/mês na cobrança anual) com 5 membros, e o Enterprise custa $99/mês (ou $82.50/mês na cobrança anual) com 10 membros e adiciona acesso à API, docs de API completa, analytics, exportação PDF e Markdown, SSO/SAML e logs de auditoria. O teste gratuito de 14 dias não exige cartão de crédito, e os leitores do seu portal publicado nunca são cobrados como assentos.