Avaliar Discernir
Discernir as principais qualidades do produto e, se for o caso, compará-lo com outros.
Os usuários da documentação são também potenciais clientes ou adotantes. Um produto ou projeto de software prospera quando o número de usuários ativos aumenta. Quem lê a documentação deve conseguir discernir as principais qualidades do produto e, se for o caso, compará-lo com outros. Trata-se de um processo de descoberta.
Dois exemplos de documentação que abordam a avaliação de forma mais ou menos explícita são What is Databricks? e a Splunk Observability Cloud Service Description, que eu criei. Apresentam os principais pontos fortes e o posicionamento do produto, junto com informações que ajudam os potenciais clientes a decidir se devem seguir em frente.
Essa dimensão de venda discreta é frequentemente negligenciada pelos frameworks de documentação, deixando que o SEO e o marketing conduzam a documentação para algo que já não é documentação. Quando a documentação é produzida com a avaliação em mente, fica mais fácil manter o marketing sob controle e também se abre a possibilidade de usar métricas de conversão.
O que o usuário quer fazer
Os usuários da documentação são também potenciais clientes ou adotantes. Quem lê deve conseguir discernir as principais qualidades do produto e compará-lo com outros. Trata-se de um processo de descoberta.
Sinais de que a documentação não atende a essa necessidade
- As equipes de suporte e vendas respondem repetidamente às mesmas perguntas: “O que é isso?”
- Os potenciais clientes descobrem o que o produto faz no material de marketing, não na documentação.
- Não existe uma página que apresente o posicionamento ou os principais pontos fortes do produto.
Dois exemplos reais
Tipos de conteúdo comuns
| DITA | Diátaxis | Good Docs Project |
|---|---|---|
| <topic>, <concept> | Sem equivalente direto (o mais próximo é Explicação) | Visão geral, Página de destino |
Uma métrica
conversão · Taxa de conversão da documentação para a adoção do produto.