Verificador de complexidade de instruções

Encontre passos que fazem coisas demais, ficam vagos ou escondem quem age.

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 complexidade de instruções

Boas instruções fazem uma coisa por passo. Cole um procedimento em inglês e cada passo é verificado em busca dos problemas que fazem as pessoas parar e reler: duas ou mais ações, como select e click, na mesma linha, condições que começam com if ou unless, passos acima do limite de palavras, palavras vagas como simply, just ou as needed, e voz passiva.

Se o texto tiver um título Procedure ou Steps, só os passos abaixo dele são verificados. Caso contrário, todos os passos ou frases são. A nota é Baixa quando nenhum passo é sinalizado, Moderada quando menos de um terço é, e Alta acima disso. Cada alerta diz o que fazer, por exemplo dividir em passos separados ou pensar num passo de decisão separado.

Exemplo

Entrada

## Procedure
1. Open Users.
2. Select the account and click Reset MFA.
3. If the user is an admin, notify security.
4. Simply close the ticket.

Resultado

Complexity: High (3 of 4 steps need attention)
1. Clear
2. 2 actions (select, click), split into separate steps
3. Condition (if), consider a separate decision step
4. Vague or jargon words: simply

Como usar: Verificador de complexidade de instruções

Cole o procedimento, de preferência com um título Procedure acima dos passos.
Ajuste Sinalizar frases com mais de para o seu limite de palavras por passo.
Corrija cada passo que não esteja marcado como Sem problemas, começando pelos que têm mais de um alerta.

Bom saber

As ações são encontradas a partir de uma lista fixa de verbos comuns de interface. Passos que combinam verbos menos comuns, como pick ou launch, podem não ser sinalizados como multiação.
Algumas palavras vagas têm usos inofensivos. Just em just under 2 MB e some em some users também são sinalizados, então use o bom senso.
Condições são sinalizadas mesmo quando são a escolha certa. Um if curto no início de um passo muitas vezes é mais claro do que um passo de decisão separado.

Perguntas sobre Verificador de complexidade de instruções

Como escrever instruções passo a passo claras?

Comece cada passo com um verbo, dê uma ação por passo, cite o botão ou o campo exato e diga o que o leitor deve ver depois. Coloque as condições primeiro, como em Se aparecer um erro, e tire as explicações dos passos, levando-as para notas.

Por que cada passo deve ter só uma ação?

As pessoas seguem instruções alternando entre o documento e a tela. Com uma ação por passo, elas reencontram onde estavam e, se algo falhar, conseguem dizer exatamente qual passo deu errado. Duas ações na mesma linha é o motivo mais comum para um passo ser pulado.

Por que evitar palavras como simply e just?

Elas dizem ao leitor que o passo é fácil, o que faz quem trava se sentir culpado, e não acrescentam nada à instrução. Removê-las deixa os passos mais curtos e neutros. Expressões como as needed são piores, porque escondem uma decisão que o leitor precisa tomar.