Introduza uma lista com um título, uma sentença ou uma frase que termina com dois pontos. Comece cada entrada da lista com uma letra maiúscula.

Marcadores

Utilize uma lista com marcadores para uma lista desordenada de conceitos, itens, ou opções.

 

Exemplo

O proprietário da base de dados pode:

  • Criar, editar ou deletar a base de dados.
  • Adicionar, modificar ou deletar um documento.
  • Adicionar, modificar ou deletar uma informação na base de dados.


Caixa de  seleção (CheckBox)

Quando a configuração de uma funcionalidade do sistema for realizada por caixa de seleção com comportamentos diferentes da simples opção de execução da funcionalidade, deverá conter a explicação das duas opções :

ErradoCorreto
  • Marcada: O sistema calcule o juros retroativo a data de vencimento.
  • Desmarcada: O sistema não calcula os juros retroativo a data de vencimento.
  • Marcada: O sistema irá calcular os juros retroativo a data de vencimento.
  • Desmarcada: O sistema irá calcular os juros retroativo a data de vencimento e incluir o valor da multa configurada em ...


Utilize listas numeradas para procedimentos ou outras listas sequenciais. Você pode introduzir uma lista numerada de duas formas:
Lista Numerada

  • Com um título que utiliza uma frase no infinitivo.
  • Com uma sentença no modo imperativo, ou indicativo.

Utilize listas verticais nas seguintes situações:

  • Quando possuir uma lista de 5 ou mais itens.
  • Quando possuir uma lista com dois ou mais itens que possuam duas ou mais palavras.

Se uma lista possuir mais de 9 itens, tente identificar uma forma de dividir a lista eu duas ou mais listas.

Não finalize uma frase introdutória com uma preposição.

ErradoCorreto

Esta seção explica como:

  • Prevenir usuários não autorizados a conseguirem acesso ao sistema.
  • Proteger servers compartilhados.
  • Criar nomes de usuários e senhas.

Esta seção explica como realizar os seguintes procedimentos:

  • Prevenir usuários não autorizados a conseguirem acesso ao sistema.
  • Proteger servers compartilhados.
  • Criar nomes de usuários e senhas.

Passo a Passo

Um passo a passo deve compreender todo o contexto do procedimento realizado. 

Ao escrever um passo a passo de um procedimento, não assuma que os usuários leram os procedimentos anteriores ou necessários para que este ocorra.

Sempre que for necessário ter realizado outro passo a passo como pré-requisito ou parte deste, referencie o tópico a que o passo pertence.

  • Informe o caminho para chegar nas funcionalidades ou telas.

  • Ordene e numere os passos.

    ErradoCorreto
    • Abra o sistema. 
    • No campo Usuário preencha com seu login.
    • No campo Senha informe sua senha da rede.
    • Clique no botão Enter.
    1. Abra o sistema
    2. No campo Usuário preencha com seu login.
    3. No campo Senha informe sua senha da rede.
    4. Clique no botão Enter.
  • Torne cada passo curto e equivalente à uma ação apenas.
  • Escreva cada passo como uma sentença completa no modo imperativo.
  • Não utilize mais que 20 palavras para escrever um passo. 
  • Não utilize mais que 9 passos para descrever um procedimento, sempre que possível separe os passos em subpassos. 
  • Passos Opcionais:  
    • Não identifique um passo como opcional se o usuário precisa completar o passo para o procedimento ter sucesso.

    • Indique um passo opcional incluindo a palavra "Opcional" entre parênteses no início do passo. 

      ErradoCorreto
      1. Passo 1.
      2. Passo 2. Opcional
      3. Passo 3
      1. Passo 1.
      2. (Opcional) Passo 2.
      3. Passo 3.

    • Se o usuário puder tomar diferentes caiminhos em um mesmo passo, indique-as através de uma lista com marcadores.

      ErradoCorreto
      1. Clique no menu Projects.
      2. Crie um novo projeto, para isto: forma 1; forma 2 ou forma 3. 
      3. Preencha os campos...
      1. Clique no menu Projects.
      2. É possível criar um novo projeto das seguintes formas:
        • forma 1
        • forma 2
        • forma 3

  • Caso a opção da lista possua subpassos, identifique sua sequência através de letras. 

    ErradoCorreto
    1. Clique no menu Projects.
    2. É possível criar um novo projeto das seguintes formas:Preencha os campos..
      • forma 1
        • Passo 1
        • Passo 2
      • forma 2
      • forma 3
    1. Clique no menu Projects.
    2. É possível criar um novo projeto das seguintes formas:Preencha os campos..
      • forma 1
        1. Passo 1
        2. Passo 2
      • forma 2
      • forma 3