Qual software você precisa para criar o corpo da documentação online do seu produto? Existe uma grande variedade de ferramentas profissionais que atendem às necessidades dessa tarefa específica. Clickhelp. com é um exemplo de tal software (e ainda mais, de um ambiente completo) que você precisa para criar documentação online com facilidade.
Ambiente de Coworking
Basta instalar o OpenOffice.org ou uma de suas inúmeras alternativas gratuitas para criar documentos sozinho em sua máquina local. Mas quando se trata de um grande corpo de documentação técnica para um grande projeto, é necessário muito mais. Mesmo que você lide com apenas um projeto, em primeiro lugar, existem vários escritores e designers responsáveis por várias partes dos documentos. Em segundo lugar, existem revisores e editores que supervisionam o trabalho dos escritores. Terceiro, existem desenvolvedores do próprio software que precisam ficar conectados com o departamento de documentação. Se o projeto for multilíngue (o que é lógico para um produto global), tradutores também serão necessários. Por fim, existem gestores que controlam os processos.
Todos eles devem se sentir confortáveis em um ambiente de nuvem unificado. Existem vários recursos que podem transformar um serviço de nuvem com armazenamento e um editor neste tipo de ambiente:
- Um mensageiro embutido. Todos devem permanecer conectados. Com esse messenger, você pode enviar links internos, capturas de tela, eventos no calendário corporativo e assim por diante. Os dados que você envia permanecem seguros.
- Ferramentas de agendamento. Você precisa marcar eventos, atribuir tarefas, monitorar seu status, definir prazos, reatribuir tarefas a outros especialistas (se necessário), verificar se eles estão ocupados e assim por diante.
- Fluxo de trabalho personalizável. Pode haver tarefas diferentes que requerem equipes diferentes e abordagens diversas.
Também é importante fazer com que esse serviço seja compatível com várias plataformas, especialmente em nossa era de bloqueio, quando tudo fica mais remoto. Os funcionários agora não apenas trazem seus próprios dispositivos, mas também trabalham em casa com tudo o que têm ou consideram necessário. Portanto, as ferramentas online precisam estar acessíveis por meio de todos os navegadores mais populares para Windows, Mac ou Linux. Pode haver um aplicativo móvel que combine um mensageiro, um calendário, um editor personalizável e o que for necessário.
Editores Configuráveis
Quando se trata de documentação online para software, inevitavelmente surgem as diretrizes que definem o resultado. Alguns deles são ditados por pura usabilidade, outros vêm de recursos específicos do software e, às vezes, é necessário manter os documentos projetados em seu estilo corporativo. Para tornar sua documentação mais fácil e rápida, você só pode optar pelas ferramentas de que necessita para fazê-la.
O que você pode descartar dos editores? Algumas opções de formatação e fontes podem ser supérfluas. Os recursos mais necessários podem ser colocados antes dos outros, de modo que sejam os mais fáceis de acessar. As fontes aparecem em ordem de frequência, portanto, as mais solicitadas vêm em primeiro lugar. Você pode precisar alternar para visualização de código ou se sentir bem com um editor puramente visual. Finalmente, você pode criar várias versões do editor, dependendo da posição. Redatores técnicos, digamos, acessam apenas a versão básica, enquanto editores e gerentes podem redigir páginas com um conjunto maior de ferramentas.
Modelos
Você pode considerar a criação de documentos a partir do zero como a única maneira. No entanto, os modelos podem economizar milhares de horas com o simples fato de existirem. Um bom modelo pode precisar de muito poucas alterações para se adequar aos seus requisitos e ter a aparência que você deseja. Claro, a documentação é basicamente funcional, com pouco espaço para os experimentos dos designers. Ainda assim, existem graus de liberdade suficientes.
Não só pode haver modelos para páginas do portal de documentação. Pode haver configurações de editor, modelos de fluxo de trabalho e assim por diante. Tudo que é personalizável é melhor com alguns exemplos.
Os modelos, na verdade, são apenas parte de uma estrutura de vários níveis. Se você deseja criar sua documentação rapidamente, deve ser capaz de fazê-lo em minutos com modelos, ferramentas de importação e editores rápidos. Mas se você quiser personalizá-lo mais profundamente, pode precisar de ferramentas mais profissionais, permitindo que você edite e ajuste tanto o conteúdo quanto a usabilidade.
Usabilidade Final
É importante facilitar a criação de documentação. Mas é crucial tornar a documentação pronta fácil de usar pelos clientes. Portanto, o software (ou melhor, o serviço) que você usa deve oferecer suporte a recursos que aprimoram a usabilidade. Eles podem incluir:
- Hospedagem para sua documentação. Não é preciso dizer que deve fornecer espaço suficiente e integração confortável em seu site principal.
- Bate-papo ao vivo. Se um cliente tem uma pergunta a fazer, ele deve ser capaz de fazer a pergunta diretamente na página de onde surgiu ou na mais relevante.
- Alertas. Quando a nova versão chegar, você deve notificar os clientes sobre ela.
- Exportabilidade. A documentação online é ótima, mas se o seu cliente deseja ter uma cópia local, ele deve ser capaz de baixar uma versão CHM, um arquivo PDF ou uma Ajuda da Web para hospedar em seu próprio servidor.
- Integração de serviços de terceiros. Se você planeja vender seu produto globalmente, pode integrar a tradução automática. Se houver comentários previstos, você pode adicionar Disqus ou outras plataformas de comentários de terceiros.
Preços
Dificilmente pode haver algo que se encaixe melhor no modelo SaaS do que um software para a criação de documentação online. Baseado em nuvem por definição, ele oferece mais do que apenas ferramentas de criação de documentos. Com os editores, vêm vantagens como mensageiro integrado, ferramentas de gerenciamento, armazenamento em nuvem para documentos e outras coisas. Não é à toa que sua manutenção torna a assinatura a opção mais lógica.
Ainda assim, existem várias opções de pagamento, não só em valores, mas também em flexibilidade. Você pode economizar mais se apenas assinar os recursos de que realmente precisa.
Docs
A documentação online é mais eficiente do que os documentos estáticos locais, mas requer mais esforço para criar e manter. Não é de se admirar que as ferramentas para isso também sejam especiais. Porém, quanto mais clara for a imagem do seu futuro portal de documentação, mais fácil será para você encontrar o software adequado para desenvolvê-lo e mantê-lo à medida que o produto evolui. Em toda a variedade de documentação de criação de software, existe uma ferramenta para você.
