A escala de classificação da qualidade vai de "muito satisfeito" (1) até "muito insatisfeito" (5).

Guidelines para orientação à tarefa

Itens para observarClassificação
de qualidade
Escreva para o publico alvo.
  • A audiência está claramente definida.
  • Tarefas são apropriadas para a audiência pretendida.
1 2 3 4 5
Apresente as informações do ponto de vista do usuário.
  • A informação é direcionada ao usuário.
  • A informação denota o que o usuário faz e não o que produto faz.
  • A ajuda contextual reflete a posição do usuário.
1 2 3 4 5
Indique uma razão prática para a informação.
  • Os detalhes referem-se a tarefas.
  • A informação conceitual dá suporte à tarefa.
  • Somente a quantidade necessária de informação conceitual aparece antes da tarefa.
1 2 3 4 5
Se concentre em tarefas reais, e não funções do produto.
  • A informação é focada em tarefas reais, não em tarefas artificiais.
  • O foco está nas ações do usuário, não em funcionalidades e elementos da interface.
1 2 3 4 5
Utilize títulos que revelam o que é a tarefa.
  • Os títulos revelam a tarefa.
  • Os tópicos não contém pseudo tarefas.
1 2 3 4 5
Divida as tarefas em sub-tarefas discretas.
  • A relação entre tarefa e sub-tarefa é clara.
  • A sub-tarefa é discreta.
1 2 3 4 5
Forneça instruções de passo-a-passo, claras.
  • A primeira sentença de cada passo inclui um verbo imperativo.
  • Os passos são dimensionados apropriadamente.
  • Os sub-passos e listas não ordenadas são utilizadas corretamente.
  • Os passos opcionais são marcados claramente.
  • Passos condicionais iniciam com a condição.
1 2 3 4 5

Guidelines para acurácia

Itens a observar

Classificação

de qualidade

Escreva as informações apenas quando você entendê-as e depois confirme se estão corretas.
  • Os procedimentos estão corretos, funcionam quando um usuário os segue.
  • A informação descritiva é precisa.
1 2 3 4 5
Mantenha a documentação atualizada com as alterações técnicas.
  • A informação final inclui mudanças finais do produto.
  • Atualizações da informação Web ocorrem em uma frequência aceitável.
  • Listas de marcas registradas são atuais.
  • A informação sobre edições anteriores é atual e válida.
  • Descrições da interface são condizentes com a interface atual.
  • As referências de produtos específicos são atuais.
1 2 3 4 5
Mantenha a consistência de todas as informações sobre um assunto.
  • A informação duplicada é consistente.
  • Não existe conflitos entre tópicos separados, porém relacionados.
1 2 3 4 5
Utilize ferramentas que automatizam a verificação de acurácia.
  • Exemplos, descrições de sintaxe, procedimentos, e outros tipos de informação são livres de erros de ortografia.
  • O texto é livre de erros de gramática.
1 2 3 4 5
Verifique a acurácia das referências contidas nas documentações.
  • Referências cruzadas estão corretas.
  • Citações contém informações relevantes.
  • Os títulos e número de ordem em referências são precisos.
1 2 3 4 5

Guidelines para documentação completa

Itens a observarClassificação
da qualidade
Cubra todos os tópicos que suportam as tarefas do usuário e apenas esses.
  • A informação não contém temas irrelevantes como produtos internos.
  • Os tópicos cobrem a informação que o usuário precisa para realizar as tarefas.
  • A quantidade de informação conceitual é apropriada para a audiência.
  • Informações que não estão diretamente direcionadas a tarefas possuem informação do porque são importantes.
1 2 3 4 5
Detalhe cada tópico apenas com a informação que o usuário precisa.
  • Explicações contém detalhes suficientes.
  • Os procedimentos ou tarefas são completos, sem faltar nenhum passo.
  • As regras de sintaxe são completas.
  • As descrições de sintaxe incluem todos os elementos.
  • Os tópicos primários providenciam mais detalhes que tópicos secundários.
  • Somente os usos mais comuns são descritos em detalhes.
  • Novos conceitos são desenvolvidos suficientemente.
  • Referências a informações relativas são significativas.
  • A informação introdutória é detalhada suficientemente para o público.
1 2 3 4 5
Use padrões de informação para garantir a cobertura necessária.
  • Explicações de informação paralela proporcionam um nível de detalhe similar.
  • Partes padrão estão disponíveis.
1 2 3 4 5
Apenas repita a informação quando o usuário tiver algum benefício.
  • A informação é repetida quando é importante para o usuário.
  • A informação não inclui seções repetidas desnecessariamente.
1 2 3 4 5

Guidelines para clareza

Itens a observarClassificação
de qualidade
Foque no significado.
  • As sentenças são concisas.
  • Os parágrafos são focados.
  • Os verbos são precisos.
  • Palavras não significativas não são utilizadas.
  • Somente modificadores necessários são utilizados.
1 2 3 4 5
Evite ambiguidade.
  • As palavras são fáceis de traduzir.
  • Os antecedentes pronominais são óbvios.
  • Os modificadores são localizados apropriadamente.
  • As cadeias de substantivos são curtas.
  • As expressões são positivas.
  • A sintaxe das sentenças é clara.
1 2 3 4 5
Mantenha elementos curtos.
  • As expressões são concisas.
  • As palavras são diretas.
  • O comprimento das listas é apropriado para o conteúdo.
1 2 3 4 5
Escreva de forma coesa.
  • As transições são suaves.
  • Listas, tabelas e exemplos são integrados.
1 2 3 4 5
Apresente a informação similar de forma similar.
  • Os tipos de listas são apropriados para a informação.
  • Os itens da lista são paralelos na estrutura.
  • As tabelas são bem segmentadas.
1 2 3 4 5
Utilize termos técnicos somente se forem necessários e apropriados.
  • Os termos são apropriados.
  • A utilização de termos é consistente.
  • Os jargões não são utilizados.
1 2 3 4 5
Defina cada termo que é novo para o público alvo.
  • Os termos são definidos.
  • Acrônimos e abreviações são definidas.
  • As definições são fáceis de entender.
1 2 3 4 5

Guidelines para documentação concreta

Itens a observarClassificação
de qualidade
Escolha exemplos que são apropriados para a audiência e assunto.
  • Exemplos são apropriados para o público.
  • Os conceitos possuem exemplos apropriados.
  • Tarefas e procedimentos possuem exemplos apropriados.
  • Informações de referência possuem exemplos apropriados.
1 2 3 4 5
Use exemplos realistas, objetivos e atualizados.
  • Cada exemplo corresponde a uma necessidade particular.
  • Os exemplos são realistas.
  • Os exemplos textuais e de código são precisos e atualizados.
1 2 3 4 5
Torne os exemplos fáceis de localizar.
  • Exemplos textuais e de código são fáceis de localizar.
  • Os exemplos estão na interface do usuário.
  • O início e término dos exemplos está claro.
1 2 3 4 5
Defina o contexto para exemplos.
  • As introduções condizem com os exemplos e cenários.
  • O texto que é introduzido como um exemplo, é um exemplo.
1 2 3 4 5
Relacione informação não familiar a informações familiares.
  • Analogias e similaridades são providas quando necessárias.
  • A base para comparação é clara.
1 2 3 4 5
Utilize linguagem geral apropriadamente.
  • A linguagem geral evita abstrações.
  • A linguagem geral é utilizada com moderação.
1 2 3 4 5

Guidelines para estilo de escrita

Itens a observarClassificação
de qualidade
Use a gramática corretamente.
  • As sentenças não possuem erros gramaticais.
  • Os parágrafos não possuem fragmentos.
1 2 3 4 5
Use ortografia correta e consistente.
  • Os termos são mencionados corretamente.
  • Palavras comumente confundíveis são usadas corretamente.
1 2 3 4 5
Use pontuação correta e consistente.
  • A pontuação condiz com o guia de estilo.
  • A pontuação é usada corretamente e consistentemente.
1 2 3 4 5
Escreva com o tom apropriado.
  • O tom é apropriado para o público alvo.
  • O tom é consistente.
1 2 3 4 5
Use um estilo ativo.
  • Os agentes dos verbos são aparentes.
  • A voz passiva é usada criteriosamente.
  • O tempo presente é utilizado apropriadamente.
1 2 3 4 5
Use o humor apropriado.
  • As instruções estão na voz ativa.
  • Os modos imperativos e indicativos são usados apropriadamente.
1 2 3 4 5
Siga os templates de design e texto padronizado.
  • Os templates reforçam a consistência.
  • Textos padrões são usados apropriadamente como textos legais, diretos de uso, marca registradas e etc.
1 2 3 4 5
Crie e siga guidelines de estilo.
  • Os itens das listas são consistentes.
  • A informação é livre de linguagem tendenciosa.
  • Os marcadores são consistentes e conforme o guia de estilo.
1 2 3 4 5

Guidelines para organização

Itens a observarClassificação
de qualidade
Organize a informação em tópicos discretos por tipo.
  • Os tópicos são discretos.
  • Os tópicos contém somente um tipo de informação: conceito, tarefa ou referência. 
1 2 3 4 5

Organize tarefa por ordem de uso.

  • Tópicos de tarefas estão em ordem de uso.
  • Passos de tarefas estão em ordem de uso.
  • Uma quantidade suficiente de informação conceitual introduz a tarefa.
1 2 3 4 5

Organize tópicos para fácil localização

  • Os tópicos são fáceis de localizar.
  • A informação é fácil de encontrar dentro de um tópico.
  • A ordem dos tópicos faz sentido para o usuário.
1 2 3 4 5

Separe informação contextual de outros tipos de informação.

  • A informação contextual é fácil de encontrar.
  • A informação contextual está disponível na interface ou associada a partir de tópicos de tarefas.
1 2 3 4 5
Organize a informação de forma consistente.
  • A sequência dos tópicos é consistente.
  • A organização de conteúdo padrão é consistente.
1 2 3 4 5
Providencie um número apropriado de subitens para cada ramo.
  • As subtópicos estão logicamente subordinadas aos seus ramos.
  • Cada ramo possui um número suficiente de subtópicos.

1 2 3 4 5

Enfatize pontos principais; subordine pontos secundários.

  • Os parágrafos enfatizam pontos principais.
  • Os detalhes apoiam pontos principais, e não os pontos subordinados.
  • As notas de rodapé são raras e apropriadas.
1 2 3 4 5
Revele como as partes se encaixam.
  • O painel de navegação, mapa do site, ou conteúdo da tabela mostra a organização.
  • Transições e overviews providenciam relação entre tópicos quando necessário.
  • A hierarquia dos tópicos está aparente.
1 2 3 4 5

Guidelines para um documento recuperável

Itens a observarClassificação
de qualidade
Facilite a navegação e busca.
  • Links navegacionais estão disponíveis.
  • Meta tags contém os termos apropriados.
1 2 3 4 5
Providencie um índice completo e consistente.
  • Cada tarefa, conceito, tópico de referência e assunto principal está indexado.
  • As entradas do índice são específicas.
  • Variações e sinônimos para entradas de índice estão incluídas.
  • Um índice online têm somente algumas variações e sinônimos para entradas.
  • Um índice impresso possui muitas variações e sinônimos para entradas.
  • Entradas em um índice impresso possuem números da página em somente um nível.
  • Entradas em um índice impresso não possuem mais que dois números de página.
1 2 3 4 5
Use um nível apropriado do sumário.
  • Um sumário online inclui todos os tópicos principais.
  • Se links expansíveis são utilizados, o nível mais alto indica claramente qual informação contém.
1 2 3 4 5
Providencie pontos de entrada úteis.
  • Os parágrafos contém de três a cinco sentenças.
  • Títulos, rótulos e listas equilibram o texto.
  • Títulos identificam claramente o tema, com a informação que o distingue no ínicio.
  • O número de títulos é apropriado.
1 2 3 4 5
Utilize links corretamente.
  • Links são providenciados somente quando são úteis.
  • Links são providenciados consistentemente.
  • Os links não confundem um tema.
  • Em informação impressa, referências cruzadas no texto são mantidas em um nível mínimo.
  • Não há mais que um link (dentro do texto) para cada dois parágrafos do texto online.
1 2 3 4 5
Crie links úteis.
  • O palavreado dos links e referencias cruzadas descrevem a informação alvo.
  • A lista de links enfatiza as palavras que são diferentes.
  • Os links associados a diferentes localizações ou níveis são mínimas.
  • Links redundantes são utilizados somente quando apropriados.
1 2 3 4 5
Faça a informação associada, fácil de localizar o tópico alvo do link.
  • A informação associada é destacada no texto ou está na primeira sentença.
  • Termos-chave e definições estão demarcados apropriadamente.
  • Somente dois ou três tipos de demarcações são utilizadas.
1 2 3 4 5

Guidelines para eficácia visual

Itens a observar

Classificação

de qualidade

Use elementos visuais que são significativos e apropriados.

  • Os elementos visuais tornam o texto mais significativo.
  • Conceitos significativos estão ilustrados.
  • Os elementos visuais mostram somente o que os usuários precisam ver.
1 2 3 4 5
Escolha elementos visuais que complementam o texto.
  • Os elementos visuais providenciam a informação que os usuários precisam.
  • Os elementos visuais ajudam a providenciar uma visão geral de conceitos importantes.
  • Os elementos visuais ilustram a informação do ponto de vista do usuário.
1 2 3 4 5
Use elementos visuais para enfatizar.
  • Elementos visuais enfatizam a informação apropriada.
  • Elementos visuais não são distrativos.
1 2 3 4 5
Use elementos visuais de forma lógica e consistente.
  • A hierarquia de títulos é visualmente lógica e consistente.
  • Os elementos visuais são apresentados e posicionados de forma consistente.
  • O look and feel é limpo e consistente.
  • Os símbolos, ícones e controles de navegação são utilizados consistentemente.
1 2 3 4 5

Balanceie o número e localização dos elementos visuais.

  • O texto é quebrado por espaço em branco ou estruturas variadas.
  • Espaços em branco aparecem intencionalmente, não acidentalmente.
1 2 3 4 5

Use pistas visuais para facilitar o usuário a localizar o que precisam.

  • Elementos visuais ajudam a guiar os usuários para caminhos corretos.
  • Recursos visuais não são ambíguos.
  • Recursos visuais são usáveis em todos os ambientes.
1 2 3 4 5
Garanta que elementos textuais estão legíveis.
  • O tipo e tamanho é apropriado para o meio de entrega e leitura.
  • O texto se encaixa no espaço disponível.
  • O texto em sequência está em um tipo e tamanho legível.
  • O contraste entre o texto e o fundo é suficiente.
1 2 3 4 5

Use cores e sombreamento de forma discreta e apropriada,

  • A cor ou sombreamento enfatiza a informação apropriada.
  • As cores providenciam contraste suficiente para usuários daltônicos.
  • As cores e sombreamentos são consistentes.
  • A cor não passa significados que podem ser ambíguos ou ofensivos em outras culturas.
1 2 3 4 5
Garanta que todos os usuários podem acessar a informação.
  • Os gráficos auxiliam, mais do que repõe o texto.
  • Legendas de figuras e textos alternados descrevem adequadamente os gráficos.
  • As estruturas gramaticais e do documento como tabelas, são simples e usadas apropriadamente.
1 2 3 4 5