Verificador de legibilidade de documentação

Tenha a facilidade de leitura Flesch e o nível escolar de cada seção.

Roda no seu navegador
Sem uploads
Sem conta

Esta ferramenta analisa texto em inglês.

Carregando a ferramenta no navegador…

O que faz: Verificador de legibilidade de documentação

Fórmulas de legibilidade transformam o tamanho das frases e das palavras numa pontuação. Cole um artigo de ajuda, um SOP ou uma página de documentação em inglês para ver o Flesch Reading Ease, em que mais alto é mais fácil, e o nível escolar Flesch–Kincaid, em que mais baixo é mais fácil, para o texto inteiro e para cada seção abaixo do seu título.

A tabela de seções é o que torna isso útil em documentos longos: uma única seção Architecture densa pode arrastar um guia amigável para a faixa difícil, e seções com pontuação abaixo de 50 aparecem em negrito. Blocos de código e títulos ficam de fora, então uma página cheia de exemplos não é penalizada. Frases acima do limite, 25 palavras por padrão, são contadas num bloco próprio.

Exemplo

Entrada

## Quick start
Open the app. Click New video. Pick a recording from your library.

## How rendering works
The renderer combines your recording, the generated voiceover, and the caption track into a single file. Larger projects take longer because every frame is processed again.

Resultado

Reading ease: 52.2 (fairly difficult)
Grade level: 7.9
Quick start: ease 69, grade 4.7
How rendering works: ease 41, grade 10.8

A seção Quick start, de frases curtas, é fácil de ler; as palavras mais longas da segunda seção puxam a pontuação geral para baixo de 60.

Como usar: Verificador de legibilidade de documentação

Cole o documento com os títulos, ou clique em Usar exemplo.
Ajuste Sinalizar frases com mais de para a frase mais longa que o seu guia de estilo permite.
Comece a revisão pelas linhas em negrito da tabela Seção, Facilidade, Nível, Palavras.

Bom saber

As sílabas são estimadas com regras e uma lista de exceções, então nomes de produtos e termos técnicos podem subir ou descer a pontuação alguns pontos.
Seções muito curtas dão pontuações instáveis, porque uma única palavra longa pode mover muitos pontos numa seção de duas frases. Avalie seções de 100 palavras ou mais.
A pontuação pode ficar abaixo de zero em textos técnicos densos. É assim que a fórmula de Flesch funciona, não um erro.
Pontuações de legibilidade medem o tamanho das frases e das palavras, não a clareza. Para achar palavras vagas e passos com várias ações, use o Verificador de complexidade de instruções.

Perguntas sobre Verificador de legibilidade de documentação

Qual é uma boa pontuação no Flesch Reading Ease?

De 60 a 70 é inglês simples, que a maioria dos adultos lê com conforto, e é uma boa meta para conteúdo de ajuda. De 70 para cima é fácil. Abaixo de 50 é razoavelmente difícil, e abaixo de 30 parece texto acadêmico. Documentação técnica costuma ficar entre 40 e 59.

Em que nível escolar a documentação deve ser escrita?

Busque o nível 8 ou menos em centrais de ajuda, onboarding e SOPs. Documentação para desenvolvedores costuma ficar entre os níveis 9 e 12 por causa dos termos técnicos, mas manter as frases curtas ainda ajuda quem não tem o inglês como primeira língua.

Como o nível escolar Flesch–Kincaid é calculado?

É 0,39 vezes a média de palavras por frase, mais 11,8 vezes a média de sílabas por palavra, menos 15,59. O Reading Ease usa as mesmas duas medidas com pesos diferentes. Frases mais curtas e palavras mais curtas melhoram a pontuação.

Como deixo um SOP mais fácil de ler?

Mantenha uma ação por passo, comece cada passo com um verbo, use as palavras que a sua equipe realmente usa e leve o contexto para uma seção separada. Confira a pontuação aqui e olhe primeiro as seções com menor facilidade.