Breadcrumbs

Padrão de escrita para manuais

Nossa voz: a voz nos manuais, é a voz do NDD Space: clara, inovadora, prestativa e confiante.

Nosso tom: o tom nos manuais é semi formal, respeitoso e prático. Somos ainda: informativos, conversacionais, amigáveis e confiáveis.

image-20231130-191006.png


Como escrevemos: usamos a voz ativa, evitamos a voz passiva .

Somos diversos: consideramos todas as pessoas independente das suas características, cultura, idioma, idade, nível de instrução ou senioridade;

Somos simples: evitamos jargões e termos técnicos que possam ser desconhecidos ou difíceis para as pessoas;

Somos diretos: escrevemos frases curtas e parágrafos bem estruturados para facilitar a leitura e a compreensão do texto;

Somos lógicos: as pessoas devem conseguir encontrar as informações de forma rápida e fácil;

Usamos imagens e ilustrações: demonstramos sempre que necessário, através de imagens e ilustrações um exemplo do que estamos falando;

Revisamos sempre: garantimos que o texto esteja claro, preciso e livre de erros. 

Usamos elementos visuais com cautela: cuidamos para que os elementos como notas, avisos e informações importantes não sejam usados fora do contexto e em grande quantidade;

Evitamos emojis: nosso tom de voz é semi formal, somos práticos e diretos; o uso de emojis pode nos distanciar desse objetivo;

Fornecemos instruções detalhadas: demonstramos passo a passo tarefas comuns, como criar e salvar ações na interface para ajudar as pessoas a realizarem tarefas com segurança;

Fornecemos suporte: incluímos um espaço de resolução de problemas para ajudar as pessoas a lidarem com dificuldades comuns que possam encontrar durante o uso do NDD Space;

Atualizamos sempre: temos um processo para manter a documentação atualizada à medida que o NDD Space evolui;

Ouvimos as pessoas: coletamos feedback das pessoas sobre a documentação para aprimorar continuamente nossas orientações de escrita para manuais.