6 melhores ferramentas de documentação: uma lista com curadoria para 2022

Procurando as melhores ferramentas de documentação para ajudá-lo a criar conteúdo de documentação interna ou externa de alto nível?

Esteja você criando documentação pública para consumidores não técnicos ou conteúdo técnico, como a documentação da API do seu software (ou qualquer coisa intermediária), existem algumas ótimas ferramentas de documentação para ajudá-lo a gerenciar seu conteúdo e publicá-lo para os usuários.

Neste post, selecionamos uma lista das seis principais opções, incluindo soluções de código aberto e SaaS para todos os orçamentos (incluindo gratuitos).

Para todas as seis ferramentas, destacaremos seus benefícios, desvantagens, preços e como você pode começar sua documentação usando essa ferramenta.

Vamos pular direto!

Seis melhores ferramentas de documentação

1. Base de conhecimento heroica
2. GitBook
3. Documento 360
4. Leia os documentos
5. Noção + Motor.so
6. Helpjuice

1. Base de Conhecimento Heroica

Heroic Knowledge Base é uma ferramenta de documentação de código aberto baseada no popular software WordPress, que também é de código aberto.

Você pode instalar o Heroic Knowledge Base como um plugin no WordPress para transformar imediatamente seu site WordPress em um hub de documentação.

Como você cria seu site é com você - você pode criar um novo site WordPress que é exclusivamente para documentação ou você pode instalar Heroic Knowledge Base em um site WordPress existente para adicionar funcionalidade de documentação a esse site.

Para criar conteúdo, você pode usar o editor de blocos flexível do WordPress, juntamente com o sistema de revisão integrado do WordPress para controle de versão.

A Heroic Knowledge Base também adiciona seus próprios blocos dedicados para que você possa adicionar facilmente textos explicativos, avisos e outros destaques.

Você também obtém ferramentas para tornar parte ou toda a sua documentação privada, dependendo se você está criando uma documentação pública ou interna.

A Heroic Knowledge Base também oferece vários recursos para criar uma ótima experiência para seus visitantes e otimizar sua documentação:

• Pesquisa AJAX em tempo real com sugestões ao vivo.
• Categorias e tags para organizar artigos.
• Análise integrada para rastrear pesquisas, visualizações, eficácia de artigos e transferências para canais de suporte ao vivo.

Por ser baseado no WordPress, você também pode estender sua documentação usando outros plugins. Por exemplo, você pode usar o plug-in gratuito Multicollab para adicionar comentários e colaboração no estilo do Google Docs ao editor de conteúdo.

Benefícios

• Usuários, artigos, categorias e assim por diante ilimitados . Basicamente, não há limites arbitrários como você normalmente encontra nas ferramentas de documentação SaaS.
• Flexível . A Heroic Knowledge Base inclui vários recursos integrados para ajudá-lo a configurar sua documentação e você também pode instalar outros plugins do WordPress conforme necessário, como adicionar recursos de colaboração.
• Propriedade total dos dados . Todos os seus dados permanecem 100% em seus próprios servidores o tempo todo.
• Código aberto . Tanto o WordPress quanto o Heroic Knowledge Base são de código aberto.

Desvantagens

• Se você não quiser usar o WordPress por algum motivo, é importante observar que a Heroic Knowledge Base funciona apenas com o WordPress.

Preços

Heroic Knowledge Base começa em $ 149 para uso em um único site e um ano de suporte e atualizações. Você manterá o acesso ao software para sempre sem custo extra, mas precisará renovar sua licença para continuar recebendo suporte e atualizações após o primeiro ano.

Você também precisará de um site WordPress, que pode custar algum dinheiro se você ainda não tiver acesso a uma hospedagem de sites capaz de executar o WordPress.

Como começar

Veja como configurar um hub de documentação usando a Heroic Knowledge Base:

1. Crie um site WordPress para atuar como a base do seu hub (se você ainda não o fez).
2. Compre e instale o plugin Heroic Knowledge Base.
3. Configure o comportamento do hub de documentação usando as configurações ( Heroic KB → Settings )
4. Adicione artigos usando o editor de blocos flexível.

Você também pode adicionar outros ajustes, como criar um site de intranet, restringir o acesso a usuários conectados ou exigir uma senha para visualizar a documentação (o que pode ser útil para a documentação interna).

2. GitBook

Como o nome sugere, o GitBook é uma ferramenta de documentação mais voltada para equipes de software que precisam criar documentação pública ou privada.

Por exemplo, você pode sincronizar o GitBook com um repositório GitHub ou GitLab que contém arquivos markdown para criar sua documentação dessa maneira. No entanto, você não é obrigado a usar o Git apenas para usar o GitBook e também pode criar conteúdo usando um editor intuitivo ou importá-lo de outras fontes, como arquivos markdown, documentos do Word e muito mais.

Para organizar sua documentação, você pode usar “espaços” (ou seja, uma base de conhecimento única) e “coleções” (ou seja, uma categoria dentro de uma base de conhecimento).

Alguns outros recursos notáveis ​​incluem o seguinte:

• Controle de versão.
• Edição e colaboração em equipe ao vivo.
• Rich incorpora no editor de conteúdo.
• Exportação de PDF fácil.

Benefícios

• Use fluxos de trabalho técnicos familiares . Para equipes técnicas, o GitBook permite usar ferramentas com as quais você já está familiarizado (como Git). Ele também usa termos técnicos, como “filiais” e “solicitações de alteração” para edições.
• Recursos de colaboração . Isso pode ser útil se você tiver várias pessoas trabalhando no mesmo documento (talvez até ao mesmo tempo).
• Gratuito para organizações sem fins lucrativos. Se você é uma organização sem fins lucrativos ou está executando um projeto de código aberto, pode usar o GitBook gratuitamente.

Desvantagens

• Técnico . Se você não estiver criando documentação de software, o GitBook pode parecer um pouco complexo. As pessoas que desejam criar documentação não técnica provavelmente desejarão procurar em outro lugar.

Preços

O GitBook é gratuito para uso individual, sem fins lucrativos e projetos de código aberto. Os planos comerciais começam em $ 8 por usuário por mês, com um mínimo de 5 usuários. Portanto, o plano mais barato seria de US $ 40 por mês.

Como começar com a Base de Conhecimento Heroica

Para começar, você só precisa se registrar em uma conta do GitBook e começar a construir. Você pode sincronizar com um repositório no GitHub ou criar do zero usando os editores de conteúdo do GitBook.

3. Documento 360

O Document360 é uma ferramenta de documentação SaaS que permite criar sua própria base de conhecimento interna ou voltada para o futuro.

Por causa de sua abordagem SaaS, é muito fácil começar. Você acabou de se registrar para uma conta e começar a construir sua documentação através da interface amigável.

Você pode criar conteúdo usando um editor WYSIWYG simples com suporte a Markdown. Você também terá acesso a ferramentas de colaboração e controle de versão, o que é útil se estiver trabalhando com uma equipe.

No frontend, seus usuários terão uma interface bem projetada para navegar pelo conteúdo, incluindo toques úteis, como sugestões de pesquisa ao vivo, índice automático e muito mais.

Benefícios

• Configuração fácil . Para criar documentação, você só precisa se registrar em uma conta e começar a escrever.
• Hospedado para você . O Document360 cuida da hospedagem e manutenção de sua documentação para você, para que você nunca precise mexer com atualizações ou qualquer outra coisa.
• Características de produtividade . Você obtém acesso a alguns recursos interessantes, como lembretes automáticos de revisão, notificações para eventos da base de conhecimento e muito mais.

Desvantagens

• Caro. O plano pago mais barato já custa US $ 119 por mês e inclui apenas recursos limitados.
• Limitações . Se você precisar de mais contas de equipe ou bases de conhecimento, precisará pagar mais. Por exemplo, o plano de inicialização inclui apenas cinco contas de equipe. Se você quiser mais do que isso, pagará $ 19 por mês por conta.

Preços

O Document360 é uma ferramenta SaaS, portanto, você pagará uma taxa mensal ou anual pelo tempo que desejar. Os planos começam em US$ 119 por projeto por mês, mais US$ 39 por versão adicional da base de conhecimento e US$ 19 para cada conta de equipe além das cinco contas incluídas.

Há também um plano gratuito que permite criar até 50 artigos com 1 GB de armazenamento e acesso limitado a recursos.

Como começar com o Document360

O Document360 é uma ferramenta de documentação SaaS, o que significa que tudo o que você precisa fazer é registrar uma conta para começar.

Há uma avaliação gratuita de 14 dias para que você possa explorar todos os recursos gratuitamente.

4. Leia os documentos

Read the Docs é uma ferramenta de documentação criada especificamente para software ou documentação técnica.

Ele permite que você gerencie seu conteúdo e controle de versão usando o Git e, em seguida, implemente facilmente em uma interface de front-end amigável. Essa abordagem significa que é realmente acessível apenas para desenvolvedores... mas isso faz sentido, já que está focado na criação de documentação técnica.

Dependendo da versão que estiver usando, você também poderá acessar alguns ou todos os recursos a seguir:

• Analytics para ver o que os visitantes estão procurando e lendo.
• Resultados de pesquisa ao vivo e sugestões.
• Várias compilações simultâneas. Por exemplo, uma compilação para produção e outra para beta ou uma para a versão 1.0 e outra para a versão 2.0.
• Exportação fácil para PDF, HTML ou epub.
• Logon único via Google Workspace ou provedor VCS (GitHub, GitLab ou Bitbucket).

Benefícios

• Use ferramentas de desenvolvimento . Ao usar ferramentas como o Git para gerenciar a documentação, o Read the Docs tenta se integrar aos fluxos de trabalho existentes dos desenvolvedores de software.
• Versão forte . O Git facilita o gerenciamento de versões e você também pode publicar várias versões de seus documentos ao mesmo tempo, o que é ótimo se as pessoas estiverem usando versões diferentes do seu software.

Desvantagens

• Configuração mais complexa . Read the Docs é um pouco mais complexo de configurar do que outras ferramentas de documentação porque você precisa trabalhar via Git. No entanto, como é focado na documentação técnica, os tipos de pessoas que estão usando o Read the Docs não devem ter problemas.
• Apenas para documentação técnica . Se você não estiver criando software/documentação técnica, escolha uma ferramenta de documentação diferente, pois Ler os documentos não é para você.

Preços

Se você tiver um projeto de código aberto, o Read the Docs permite criar e hospedar sua documentação gratuitamente. Na verdade, o Read the Docs diz que hospeda documentação gratuita para mais de 240.000 projetos de código aberto.

Para empresas comerciais, há também um serviço pago Leia os documentos para empresas, que custa a partir de US$ 50 por mês. Todos os planos incluem projetos e usuários ilimitados – as principais limitações são os recursos que você obtém e o número de compilações simultâneas que você pode ter.

Como começar a ler os documentos

Ler os documentos oferece duas maneiras de escrever sua documentação real:

1. MkDocs
2. Esfinge

Depois de usar essas ferramentas para criar um repositório Git com o conteúdo da sua documentação, o Read the Docs importará automaticamente o repositório para criar sua documentação.

5. Noção + Motor.so

A noção é um pouco complicada aqui, pois não foi criada especificamente para documentação. No entanto, com a configuração correta, pode ser uma ótima ferramenta para lidar com todos os diferentes tipos de documentação.

Se você não estiver familiarizado com o Notion, ele é basicamente uma ferramenta completa para lidar com qualquer tipo de conhecimento, dados, gerenciamento de projetos e muito mais.

Você pode usá-lo para várias coisas diferentes, incluindo a criação de todos os tipos de documentação. A desvantagem, porém, é que o Notion por si só não está realmente focado em publicar essas informações em um site onde outras pessoas possam interagir com elas.

É aí que entra o Engine.so. Com o Engine.so ( um serviço de terceiros ), você pode publicar seu conteúdo do Notion em seu próprio site para criar facilmente seu próprio hub de documentação. Você pode ver um exemplo de como isso se parece na documentação do Engine.so.

Benefícios

• Formas únicas de apresentar informações . O uso do Notion oferece muita flexibilidade que você pode não obter com ferramentas de documentação mais restritas. Por exemplo, você pode usar os vários blocos Notion de maneiras interessantes.
• Fácil de usar . Ao contrário das ferramentas baseadas em Git, essa abordagem é fácil para usuários técnicos e não técnicos.
• Acessível . Embora não haja um plano gratuito, essa abordagem deve ser acessível para a maioria dos casos de uso.

Desvantagens

• Não construído especificamente para documentação . Embora o Notion funcione muito bem para documentação, esse não é o único foco, como acontece com as outras ferramentas de documentação nesta lista. Se você planeja ter centenas de artigos, talvez prefira uma ferramenta mais específica.
• Controle de versão limitada. Essa abordagem não oferece controle de versão forte. Se você pagar pelo Notion, poderá obter 30 dias de histórico de versões, mas não é tão forte quanto o Git ou o sistema WordPress que você obtém com o Heroic Knowledge Base.

Preços

O Notion tem um plano gratuito que deve funcionar bem para casos de uso básicos. No entanto, há uma chance de você querer pagar dependendo de suas necessidades específicas.

Para transformar seu conteúdo do Notion em um hub de documentação pública, no entanto, você precisará pagar pelo Engine.so. Engine.so custa US$ 19 por mês para até 300 páginas ou US$ 49 por mês para até 1.000 páginas. Você pode testá-lo com uma avaliação gratuita de 14 dias.

Como começar com noção

Veja como criar documentação usando esta configuração:

1. Registre-se para uma conta Notion.
2. Crie sua documentação usando o Notion. Você pode encontrar modelos Notion pré-fabricados para conteúdo de documentação, como esses modelos do Beestat.
3. Registre-se para uma conta Engine.so.
4. Publique sua documentação do Notion em seu próprio site/hub de documentação personalizado usando Engine.so.

6. Suco de ajuda

Semelhante ao Document360, o Helpjuice é outra ferramenta de documentação e base de conhecimento SaaS popular.

Ele ajuda você a criar facilmente qualquer tipo de documentação usando um editor de texto simples, incluindo opções para importar de documentos do Word para economizar tempo.

Você também tem acesso a vários recursos para criar uma documentação eficaz:

• Resultados/sugestões de pesquisa instantâneas.
• Analytics para rastrear pesquisas, visualizações de página e muito mais.
• Opção para publicar várias versões de sua documentação.
• Níveis de acesso do usuário para controlar quem pode ver artigos diferentes.
• Recursos de colaboração, incluindo comentários no editor.

Benefícios

• Configuração fácil . Para criar a documentação, você só precisa se registrar para uma conta.
• Hospedado para você . Helpjuice lida com hospedagem e manutenção de sua documentação para você, para que você nunca precise mexer com atualizações ou qualquer coisa.
• Não há planos bloqueados por recursos . Embora o Helpjuice não tenha um plano gratuito, todos os seus planos pagos dão acesso a todos os recursos.

Desvantagens

• Caro . O plano mais barato começa em $ 120 por mês e pode variar até $ 500 por mês.
• Limites do usuário . Se você tem uma equipe grande, o Helpjuice pode sair caro. Por exemplo, se você tiver mais de 60 usuários, precisará do plano de US$ 500 por mês.

Preços

Os planos pagos da Helpjuice começam em $ 120 por mês para todos os recursos e até quatro usuários. Os planos aumentam a partir daí com base no número de usuários que você precisa, chegando a US $ 500 por mês para usuários ilimitados.

O único é que você obtém acesso a todos os recursos em todos os planos, enquanto algo como o Document360 bloqueia determinados recursos por trás dos planos de nível superior.

Você também pode testar tudo com uma avaliação gratuita de 14 dias.

Como começar a usar o Helpjuice

Para começar, tudo que você precisa fazer é se registrar em uma conta Helpjuice e começar a adicionar seu conteúdo.

Qual é a melhor ferramenta de documentação para suas necessidades?

No final, escolher a melhor ferramenta de documentação realmente depende de suas necessidades específicas, orçamento e nível de conhecimento.

Aqui estão algumas perguntas comuns que você deve se fazer para restringir sua pesquisa:

• Você quer uma solução auto-hospedada ou está de acordo com o uso de uma ferramenta SaaS?
• Da mesma forma, você deseja uma solução de código aberto ou concorda em usar uma ferramenta de código fechado?
• Você está criando documentação muito técnica (por exemplo, documentação da API) ou mais documentação voltada para o consumidor?
• Você gosta da ideia de usar o Git para controle de versão/gerenciamento de conteúdo ou prefere ter um sistema de gerenciamento de conhecimento dedicado?
• Qual é o seu orçamento? Você concorda em pagar uma taxa mensal contínua ou deseja algo gratuito ou um pagamento único?

Ao responder a essas perguntas, você deve ter uma boa ideia de qual é a melhor ferramenta de documentação para suas necessidades.

Se você não sabe por onde começar, achamos que a Heroic Knowledge Base pode atender às necessidades da maioria das empresas. Ele oferece uma abordagem de código aberto econômica que oferece a propriedade total de seus dados a um preço menor do que a maioria das outras ferramentas.

Mas, ao mesmo tempo, você ainda tem acesso a vários recursos para criar documentação de alto nível, como sugestões de pesquisa ao vivo e análises detalhadas. Você também terá acesso a todo o ecossistema WordPress se quiser ainda mais flexibilidade.

Para saber mais e começar, acesse a página do produto Heroic Knowledge Base.