Documentação colaborativa que toda a sua equipe consegue manter de verdade
Os redatores editam de forma visual, os engenheiros trabalham em git e o GitHub Sync bidirecional mantém todos apontando para uma única fonte da verdade.
Dois tipos de colaboradores, uma única fonte da verdade
A maioria da documentação vive ou morre por uma tensão simples. As pessoas que melhor conhecem o produto nem sempre são as que se sentem à vontade em um editor de código. Seus redatores, gerentes de produto e agentes de suporte querem abrir uma página e começar a escrever. Seus engenheiros querem manter a documentação junto ao código, em Markdown, sob controle de versões, revisada como qualquer outra mudança. Se você obriga todos a um único fluxo de trabalho, metade da equipe deixa de contribuir.
O OpenDocs foi criado para a colaboração em documentação entre os dois grupos ao mesmo tempo. Os colaboradores não técnicos trabalham em um editor visual de blocos sem precisar saber Markdown nem git — eles veem páginas formatadas, movem blocos e salvam. Os engenheiros conectam um repositório do GitHub e continuam trabalhando exatamente como já fazem: editam Markdown, fazem commit em uma branch, abrem um pull request. A diferença é que não são duas cópias separadas da verdade que se distanciam pouco a pouco. É o mesmo conteúdo, mantido em sincronia de forma automática.
É isso que torna sustentável a documentação em equipe. Um líder de suporte pode corrigir a legenda de uma captura errada pela manhã, um engenheiro pode atualizar um exemplo de API naquela mesma tarde a partir do seu editor, e nenhum deles precisa abrir um chamado para o outro nem colar mudanças entre ferramentas. A documentação se mantém em dia porque quem está mais perto de cada mudança pode fazê-la diretamente, na superfície que se ajusta ao seu jeito de trabalhar.
Como funciona a colaboração no OpenDocs
Redatores e PMs no editor de blocos
O editor visual é onde vivem os colegas não técnicos. Blocos estruturados, títulos, avisos e imagens — sem sintaxe para aprender. O Assistente de escrita com IA ajuda a redigir, e o AI Writer Improver refina o tom para que muitas mãos continuem se lendo com uma única voz.
Engenheiros em Markdown e git
Conecte um repositório do GitHub e os engenheiros permanecem no seu fluxo habitual. As páginas são salvas como Markdown com frontmatter YAML, então a documentação vive junto ao código, é revisada em pull requests e viaja com cada release — docs-as-code de verdade, sem novas ferramentas para adotar.
O GitHub Sync mantém a transparência
A sincronização bidirecional une o editor e o repositório. Os salvamentos do editor geram commits de Markdown para o GitHub; os pushes ao repositório atualizam suas páginas. Quando ambos os lados mudam a mesma página, a detecção de conflitos a sinaliza com uma comparação lado a lado para que nada seja sobrescrito em silêncio.
Espaços e membros: estrutura sem o atrito da cobrança por assento
A colaboração precisa de limites, e no OpenDocs esses limites são os espaços. Um espaço é um conjunto autônomo de documentação — um produto, uma central de ajuda, um manual interno — com sua própria navegação, tema e regras de acesso. Dividir sua documentação em espaços permite que grupos distintos sejam donos de áreas distintas sem tropeçar uns nos outros, e mantém o conteúdo publicado claramente separado do trabalho que ainda não está pronto.
Somar pessoas a esse trabalho nunca deveria ser a parte cara, por isso o OpenDocs usa níveis fixos com membros incluídos em vez de cobrar por cada assento. O Pro custa $55/mês e inclui 5 membros. O Enterprise custa $99/mês e inclui 10 membros. Quando sua equipe passa da quantidade incluída, os membros adicionais são uma cobrança fixa moderada — $5/membro/mês na cobrança mensal do Pro (ou $4/membro/mês com cobrança anual) — então você pode crescer para uma quantidade praticamente ilimitada de colaboradores sem uma fatura que dá um salto cada vez que alguém entra.
O contraste com as ferramentas de documentação por assento importa sobretudo para os colaboradores que editam de vez em quando. Em um modelo por assento, o agente de suporte que corrige uma página por mês e o revisor que aprova um release custam cada um um assento recorrente completo, então as equipes acabam racionando o acesso para economizar — que é justamente como a documentação fica obsoleta. Com membros incluídos em um nível fixo, somar um colaborador ocasional é barato ou gratuito, e os leitores da sua documentação publicada nunca são cobrados.
O fluxo do GitHub Sync, em detalhe
O GitHub Sync é o mecanismo que permite que um editor visual e um repositório de git permaneçam de acordo. Você conecta um espaço a um repositório com um Personal Access Token do GitHub, e a partir daí as mudanças fluem nos dois sentidos de forma automática. Está disponível em todos os planos, incluindo o teste gratuito — não há bloqueio por nível para manter sua equipe em sincronia.
- Do GitHub para o OpenDocs. Quando alguém faz push de um commit, um webhook é disparado. O OpenDocs obtém os arquivos
.mdmodificados e atualiza as páginas correspondentes, então um engenheiro que edita Markdown nas suas próprias ferramentas vê a documentação publicada se atualizar sem tocar no app. - Do OpenDocs para o GitHub. Quando um redator salva uma página no editor de blocos, o OpenDocs gera um commit de Markdown de volta ao repositório por meio da GitHub Contents API, com frontmatter YAML que carrega o título, slug, ordem e elemento pai para que a estrutura sobreviva à viagem de ida e volta.
- Detecção de conflitos. Se a mesma página mudou dos dois lados, o OpenDocs não adivinha. Ele sinaliza o conflito e mostra uma comparação lado a lado, e você decide qual versão vence — a salvaguarda que torna confiável a edição bidirecional em uma equipe real.
O resultado é uma história genuína de docs-as-code que não exclui ninguém. Os engenheiros ganham controle de versões, revisão por pull request e documentação que é despachada com o código. Os redatores ganham uma página que podem editar sem aprender git. E como ambos editam o mesmo conteúdo sincronizado, existe apenas uma fonte da verdade para manter em dia.
Uma voz consistente entre muitos autores
O custo oculto da documentação em equipe é a deriva do tom. Dez colaboradores escrevem, naturalmente, em dez registros, e um site de documentação que se lê como um comitê enfraquece a confiança no conteúdo. O AI Writer Improver foi feito justamente para isso — execute-o sobre uma página e ele refina a redação e suaviza o tom para que as contribuições de toda a equipe aterrissem em uma voz consistente, sem que um único editor se torne o gargalo de cada mudança. Como todos os recursos de IA, é BYOK: você usa sua própria chave de API da Anthropic e o consumo é cobrado através da sua conta da Anthropic, em todos os planos.
Espaços restritos para rascunhos e trabalho interno
Nem toda colaboração é para o público. Um espaço pode ser público, para leitores que não precisam de conta, ou restrito para documentação privada na qual sua equipe ainda trabalha. Os espaços restritos são onde se juntam os rascunhos, os runbooks internos e a documentação prévia ao lançamento — a equipe colabora internamente e depois publica em um espaço público quando está pronto. Manter os dois separados evita que o trabalho em andamento vaze para os leitores, e que a documentação publicada se encha de páginas pela metade.
O que colaboração significa aqui (e o que não)
Vale a pena ser preciso, porque "colaborativo" se estica para significar muitas coisas. O OpenDocs não oferece cursores ao vivo nem edição simultânea no estilo do Google Docs sobre uma mesma página. Dois colegas não se veem digitando em tempo real. Se essa experiência específica é a que você precisa, o OpenDocs não é a ferramenta adequada e preferimos dizer isso com clareza.
O que o OpenDocs de fato dá a uma equipe é uma forma duradoura de construir documentação em conjunto: papéis claros e gestão de membros, um fluxo de git por meio do GitHub Sync que deixa pessoas técnicas e não técnicas contribuírem do seu jeito, detecção de conflitos quando as edições se chocam, e um ciclo de feedback de leitores que transforma sua audiência em mais um par de olhos sobre a precisão. Isso é colaboração medida em um site de documentação que se mantém correto à medida que cresce — e não em cursores piscando.
Os níveis fixos vencem a cobrança por assento quando sua equipe cresce
A colaboração em documentação fica mais valiosa com mais colaboradores, então um modelo de preços que te pune por adicioná-los trabalha contra todo o propósito. Muitas ferramentas de documentação e de espaço de trabalho cobram por assento, e a fatura cresce de forma linear com o número de pessoas — cada redator, editor e revisor ocasional é mais uma linha recorrente. O OpenDocs usa níveis fixos com membros incluídos, por isso uma equipe em crescimento não significa automaticamente uma fatura maior.
O Pro custa $55/mês (ou $45.65/mês na cobrança anual, $547.80/ano) com 5 membros incluídos. O Enterprise custa $99/mês (ou $82.50/mês na cobrança anual, $990/ano) com 10 membros incluídos. Além da quantidade incluída, os membros adicionais são uma cobrança fixa, e você pode crescer para uma quantidade ilimitada de colaboradores. O Enterprise adiciona analytics, exportação para PDF e Markdown, acesso à API, SSO/SAML, logs de auditoria e suporte prioritário para as organizações que precisam.
O custo de colaborar de relance
| Fator de custo | OpenDocs | Ferramentas típicas por assento |
|---|---|---|
| Modelo de preço | Nível fixo, membros incluídos | Por assento |
| Nível de equipe | $55/mês — 5 membros incluídos | Cresce com cada editor adicionado |
| Adicionar um colaborador ocasional | +$5/membro/mês (+$4 anual) | Um assento recorrente completo |
| Leitores da documentação publicada | Sem cobrança (público ou restrito) | Varia; muitas vezes com restrições |
| Sincronização bidirecional com o GitHub | Incluída em todos os planos | Muitas vezes só nos níveis superiores |
Perguntas frequentes
O que é documentação colaborativa?
Documentação colaborativa é documentação que uma equipe inteira mantém em conjunto, em vez de um único dono. No OpenDocs isso significa que os redatores, gerentes de produto e agentes de suporte editam em um editor visual de blocos enquanto os engenheiros trabalham em Markdown e git, e o GitHub Sync bidirecional mantém os dois lados apontando para uma única fonte da verdade. Papéis, revisão e um ciclo de feedback compartilhado substituem os repasses de copiar e colar que deixam a documentação desatualizada.
Redatores não técnicos e engenheiros podem trabalhar na mesma documentação?
Sim, essa é a ideia. Os colaboradores não técnicos usam o editor visual de blocos sem precisar saber Markdown nem git. Os engenheiros conectam um repositório do GitHub e trabalham em Markdown com frontmatter YAML a partir do seu fluxo habitual de branches e commits. Cada salvamento de página é sincronizado nos dois sentidos, então os dois públicos editam o mesmo conteúdo sem se atrapalhar.
O OpenDocs oferece edição colaborativa em tempo real como o Google Docs?
Não. O OpenDocs não oferece cursores ao vivo nem edição simultânea de várias pessoas sobre uma mesma página. Aqui a colaboração é baseada em papéis e gestão de membros, no fluxo de git por meio do GitHub Sync e em um ciclo de feedback de leitores, com detecção de conflitos quando duas pessoas mudam a mesma página. Se você precisa de coautoria ao vivo no estilo do Google Docs, o OpenDocs não é essa ferramenta.
Como o GitHub Sync lida com conflitos quando duas pessoas editam a mesma página?
Quando a mesma página muda tanto no editor do OpenDocs quanto no repositório do GitHub, o OpenDocs sinaliza um conflito em vez de sobrescrever em silêncio. Ele mostra uma comparação lado a lado das duas versões para que você veja exatamente o que difere e escolha qual manter. Nada se perde de forma automática, o que mantém a transparência entre redatores e engenheiros sobre quem mudou o quê.
Quantos membros de equipe estão incluídos e quanto custa adicionar mais?
O Pro custa $55/mês de forma fixa e inclui 5 membros; o Enterprise custa $99/mês e inclui 10 membros. Os membros adicionais são uma cobrança fixa ($5/membro/mês na cobrança mensal do Pro, menos com cobrança anual), então você pode crescer para uma quantidade ilimitada de colaboradores sem um preço por assento que sobe cada vez que alguém entra. Os leitores da sua documentação publicada nunca são cobrados como assentos.
Posso manter rascunhos e documentação interna privados enquanto a equipe trabalha neles?
Sim. Um espaço pode ser público ou restrito. Os espaços restritos são ideais para rascunhos, runbooks internos e trabalho em andamento que sua equipe colabora antes de publicar, enquanto os espaços públicos atendem leitores que não precisam de conta. Você controla o acesso no nível do espaço, então a colaboração e a publicação ficam claramente separadas.