Calculadora de tempo de leitura de documentação

Tenha um tempo de leitura realista para documentação com código e capturas de tela.

Roda no seu navegador
Sem uploads
Sem conta

Esta ferramenta analisa texto em inglês.

Carregando a ferramenta no navegador…

O que faz: Calculadora de tempo de leitura de documentação

Um guia para desenvolvedores com três exemplos de código e quatro capturas de tela leva mais tempo para ler do que a contagem de palavras sugere. Cole uma página Markdown e a estimativa soma três partes: texto corrido a 200 palavras por minuto, 3 segundos por linha de código e 12 segundos por imagem.

Os blocos mostram cada parte separadamente, para você ver se o tempo está na explicação ou num exemplo de configuração longo. O código em blocos cercados e recuados é contado por linha, não por palavra. Imagens em Markdown ou em tags img do HTML contam. Mude os tempos de código e de imagem em Mais opções. Para artigos simples, sem código, a Calculadora de tempo de leitura basta.

Exemplo

Entrada

## Install the CLI
Run the installer, then sign in with your workspace token. The command prints your workspace name when it works.

```bash
npm install -g example-cli
example login
example whoami
```

![Terminal after sign-in](https://example.com/cli.png)

Resultado

Reading time: 0:29 (about 1 minute)
Prose: 0:08 (26 words at 200 wpm)
Code: 0:09 (3 lines)
Images: 0:12 (1 image)

O código e a captura de tela respondem por mais de dois terços do tempo de leitura, embora o texto tenha só 26 palavras.

Como usar: Calculadora de tempo de leitura de documentação

Cole a página Markdown, ou use Abrir arquivo para carregar um arquivo .md.
Escolha um Ritmo de leitura e abra Mais opções para ajustar Tempo por linha de código e Tempo por imagem.
Veja o bloco Tempo de leitura e a divisão entre Texto corrido, Código e Imagens.

Bom saber

Linhas em branco dentro de blocos de código não contam, mas todas as outras linhas valem o mesmo, seja um comando de uma palavra ou uma linha longa de configuração.
As imagens só são contadas a partir da sintaxe de imagem do Markdown e de tags img. Vídeos incorporados, diagramas em iframes e tabelas não somam tempo.
Código inline dentro das frases conta como palavras do texto, não como linhas de código.

Perguntas sobre Calculadora de tempo de leitura de documentação

Quanto tempo deve levar a leitura de uma página de documentação?

A maioria das páginas de tarefa funciona melhor entre 2 e 5 minutos. Os leitores costumam chegar para concluir uma tarefa, então uma página de 10 minutos ou mais geralmente cobre várias tarefas e fica mais fácil de usar dividida em páginas separadas, ligadas entre si.

Devo mostrar o tempo de leitura nas páginas de documentação?

Ajuda em tutoriais e guias longos, quando o leitor quer saber se terá tempo de terminar. Em páginas curtas de referência, só polui. Se for mostrar, use uma estimativa que inclua código e imagens, porque só as palavras subestimam páginas técnicas.

Quanto tempo leva para ler código?

Muito mais por palavra do que texto corrido, porque o leitor confere a sintaxe e entende o que cada linha faz. Alguns segundos por linha é uma média razoável para código conhecido. Aumente o tempo por linha para exemplos complexos ou leitores que não conhecem a linguagem.