any2.video vs contratar um redator técnico: duas respostas para o mesmo problema de cobertura

O que cada opção prova

Quando um redator técnico é a escolha certa

• A sua documentação está incompleta, contraditória ou abandonada. Resolva isso primeiro. Vídeo em cima de documentação ruim só espalha o erro.
• O conteúdo é material de referência: parâmetros, superfícies de API, limites, explicações conceituais.
• Os leitores precisam pesquisar, copiar e linkar. Ninguém copia um comando de um vídeo.
• Você precisa do conteúdo dentro do processo de lançamento de versões, e não ao lado dele.

Quando não é

• A etapa escrita existe e os usuários ainda erram, o que normalmente significa que a tela não se parece com a frase.
• A pergunta é “funciona de verdade”, algo que o texto não consegue resolver e a evidência na tela consegue.
• Os seus compradores estão formando opinião no YouTube, onde a sua documentação não aparece.
• O redator que você contratou passa a semana fazendo capturas de tela em vez de escrever.

A ordem certa

Documentação primeiro. Se o procedimento escrito está errado, um vídeo do procedimento errado é um procedimento errado mais convincente. Já recusamos trabalhos por esse motivo e recusaríamos de novo.

Quando a documentação está certa, o que falta não é informação, é prova e reconhecimento visual. Um usuário que leu a etapa e ainda não encontra a chave não precisa da frase de novo. Precisa ver a tela.

Todo passo a passo vem com texto

É por isso que o guia escrito e as notas de solução de problemas estão incluídos, e não são vendidos como upsell. Cada execução verificada produz as etapas exatas que funcionaram, em ordem, com as tentativas que falharam e as respectivas correções. Esse resultado muitas vezes é melhor do que o que havia na documentação, porque veio de uma execução, e não da memória, e o seu redator pode levá-lo direto para a documentação.

O que o redator ganha com isso

Capturar telas é a coisa de menor valor que um redator técnico faz, e isso consome a semana de trabalho. Uma execução verificada entrega um log, com marcações de tempo, do que realmente aconteceu, que é a matéria-prima que, de outro modo, seria reconstruída à mão.

Perguntas

Devemos contratar um redator técnico ou comprar vídeo?

Se a documentação está errada ou não existe, contrate o redator primeiro. Vídeo construído sobre documentação imprecisa multiplica o erro. Se a documentação é sólida e os usuários ainda travam, o que falta é prova, e não informação, e é isso que um passo a passo verificado fornece.

O vídeo substitui a nossa documentação?

Não, e nem deveria. Texto é pesquisável, copiável e barato de corrigir. Vídeo é ruim como material de referência e bom para mostrar uma tarefa chegando ao fim.

Recebemos algo que o nosso redator possa usar?

Sim. Todo passo a passo vem com as etapas exatas que funcionaram e as tentativas que falharam, geradas a partir do log de execução. A maioria das equipes cola isso direto na própria documentação.