Guia de Redação

Objetivo

Nosso objetivo na Zenvia é simplificar o mundo, facilitando a comunicação entre as empresas e seus clientes. Por isso, é importante utilizarmos uma linguagem que expresse essa simplicidade e tenha consistência para passar segurança às pessoas que estão acessando nossos conteúdos.

Este guia foi criado a fim de orientar e apoiar as pessoas sobre as melhores práticas de escrita de textos dentro de nossos produtos, artigos, manuais, e-mails e conteúdos em geral aqui na Zenvia.

Nós somos

Para que nossos conteúdos simplifiquem o mundo de nossos clientes, trabalhamos com alguns princípios. Por isso, aqui na Zenvia, somos pessoas:

❤️ Empáticas

Nosso conteúdo é feito para pessoas! Levamos sempre em consideração quem vai acessar o conteúdo e direcionamos a linguagem. Em manuais, por exemplo, nos colocamos no lugar de alguém com pouca ou nenhuma experiência no produto.

Vale lembrar que os usuários dos serviços Zenvia normalmente se dividem em pessoas da área técnica e da área de negócio. É importante entender que público vai utilizar as informações escritas por nós. Existem termos e explicações que serão mais adequados a pessoas desenvolvedoras e termos específicos para quem atua com gestão. É importante analisar a jornada do usuário para determinar qual termo fica mais adequado.

É importante que sejamos didáticos: Explique termos, etapas de um processo de cadastro, deixe claro para a pessoa em qual etapa ela está. O texto é parte das soluções oferecidas pela Zenvia e precisa colaborar para que a comunicação seja acessível.

Para manuais e artigos, por exemplo, observe se:

• Está claro o que o sistema ou aquela função faz?
• Está claro como acessar determinado conteúdo?
• Há um passo a passo?
• Há explicação dos principais campos ou de todos aqueles que não são intuitivos?
• Há explicação do que aquela função acarreta no sistema e de como é usada no dia a dia, na prática?

🔧 Úteis

Nossa documentação responde às perguntas dos nossos usuários. E antes de escrever, nos perguntamos:

• Para que serve isto?
• Quem vai ler isto?
• O que essa pessoa quer e o que precisa saber?
• O que nós queremos que ela saiba?

🧐 Curiosas

Mais informação útil é sempre bom. Procuramos sempre por mais conteúdo. Conversamos com o pessoal de suporte, de implantação, de desenvolvimento. Quais são as principais dúvidas? O que é mais usado nesse sistema? Está documentado? Não nos contentamos com o que já existe! Vamos além!

👀 Atentas

A revisão é um trabalho constante. Cuidamos com erros de ortografia, concordância, etc. Sempre revisamos o conteúdo (lemos todo o conteúdo novamente, com calma) antes de enviar para as pessoas especialistas no produto ou para a revisão de colegas.

Nossa documentação é

Agora que você já sabe os princípios que nos guiam, veja como nossa documentação deve ser.

✔️ Correta

A documentação deve estar correta - de acordo com a realidade. Exemplos:

• ❌ O Zenvia Message é um canal de comunicação.
• ✔️ O Zenvia Message é um ambiente para disparo de mensagens dentro da plataforma da Zenvia.

📌 Relevante

A documentação precisa ser relevante para quem está lendo. Não é necessário descrever conceitos muito básicos para um público mais avançado. Não faz sentido explicar o que é uma linguagem de programação em uma documentação de API, por exemplo.

🎯 Precisa

A documentação deve oferecer a informação de forma precisa.

Exemplos:

• ❌ Você deve cadastrar os usuários.
• ✔️ Você deve cadastrar os usuários informando os campos W e Z, pois, caso contrário, podem ocorrer os erros X, P, T e O.

🧠 Lógica

A documentação deve oferecer a informação de forma logicamente consistente.

Exemplos:

• ❌ Ligue o carro e insira a chave...
• ✔️ Insira a chave na ignição para ligar o carro.
• ❌ Cadastre os usuários para acessar o sistema.
• ✔️ Acesse o sistema com o usuário admin para cadastrar os demais usuários.

✏️ Simples

A documentação deve ser simples, clara, rápida e de fácil consumo. Sem floreios! Vá direto ao ponto.

📚 Organizada

A documentação deve ser organizada de modo que a pessoa entenda onde ela está e como o conteúdo está organizado. Recursos que podem ser utilizados para organizar o conteúdo:

• Tópicos dentro da página
• Hierarquia de páginas
• Menus
• Índices

👍 Padronizada

A documentação deve seguir todos os padrões explicados neste guia. Comece e termine uma página ou manual com um mesmo padrão. Deixe o leitor entender o que você quer. Exemplos:

• ✔️ Se você usando os verbos no imperativo, continue assim.
• ✔️ Se você está organizando por tópicos, continue assim.

Tom da comunicação

Assim como nós, a marca Zenvia também possui uma personalidade. Logo, a forma como ela se comunica deve refletir os valores e demais atributos que formam a essência da marca. A Zenvia tem como foco simplificar a comunicação, por isso buscamos criar textos que tenham um tom conversacional. Tenha em mente que existe uma pessoa lendo o que é escrito, por isso mantenha um tom simples, polido, sem gírias ou abreviações, mas sem uma formalidade excessiva. Busque sempre palavras que possam ser entendidas por todos e avalie a necessidade de termos técnicos.

Desta forma, nós escrevemos num tom amigável, respeitoso e agradável. Somos calorosos e evitamos parecer muito formais ou lembrar um robô.

Linguagem inclusiva

Entendemos que a escolha do masculino como genérico e a maneira como são construídas frases, ocultando o gênero feminino, reforça e perpetua estereótipos do que um dia foram considerados “papéis adequados” para mulheres e homens na sociedade. No entanto, a simples existência de um gênero neutro (presente no idioma alemão, por exemplo) ou a ausência de gênero em substantivos (como no turco) não implica na diminuição do machismo em uma cultura. É preciso transformar a maneira de pensar. A língua é uma ferramenta viva e um dos instrumentos mais efetivos para essa evolução. A busca por substituir marcadores de gênero no discurso é um processo que explicita respeito e empatia, princípios básicos que deveriam reger as relações sociais (FISCHER, 2020).

Assim, aqui na Zenvia, nós evitamos utilizar gênero (masculino ou feminino) quando nos referimos às pessoas nos textos. Não usamos pronomes e artigos que determinam gênero, buscamos adjetivos que sejam neutros e palavras que representem um grupo de pessoas ao invés de usar o masculino. Exemplos:

• “A chefia”, em vez de “Os chefes”;
• “Pessoas que cozinham”, em vez de “Os cozinheiros”;
• “Boas-vindas”, em vez de “bem-vindo” ou “bem-vinda”;
• “Pessoas que acessam o sistema” em vez de “usuários”.

Acessibilidade

É importante evitar termos complexos que dificultem o entendimento do que está escrito. Use palavras simples, diretas e que sejam de uso comum. Use com cuidado termos em línguas estrangeiras, pois mesmo expressões que parecem populares podem tornar a comunicação da Zenvia inacessível para um grupo de pessoas. Em áreas específicas, acessadas por usuários que possuam um perfil técnico, verifique se termos técnicos estão utilizados da forma e com a grafia correta.

Observação: Na logomarca e demais itens da marca, entendemos o uso da palavra Zenvia em caps lock. Porém, por conta da acessibilidade, no blog, nas documentações de manuais, artigos para clientes e demais materiais da Zenvia, utilizamos a escrita Zenvia. Com a primeira letra maiúscula e o restante minúscula.

Gramática e outros padrões

As regras gramaticais nos ajudam a manter uma escrita clara e consistente. De maneira geral, seguimos a Norma Culta da Língua Portuguesa, mas usamos um tom coloquial. (Sabemos que isso pode gerar bastante discussões filosóficas, mas o propósito ficará mais claro com os exemplos a seguir.)

Letras maiúsculas e minúsculas

Títulos e subtítulos na documentação

Todos os títulos de páginas devem ficar bem explicativos, para facilitar a busca do usuário. Sintetize o título dos itens quando forem muito extensos. Elimine artigos (a, o, as, os) quando possível.

Heading 1 (título da página):

• Podemos começar os títulos com substantivos e deixar todas as iniciais maiúsculas, exceto preposições e artigos (de, a, para, com, etc.).
• Podemos utilizar sempre a primeira letra maiúscula, com o restante em letras minúsculas (exceto nomes próprios).
• Quando o título for uma pergunta, só a primeira letra fica maiúscula (exceto nomes próprios) e deve ser colocado o ponto de interrogação.
• Também podemos começar com o gerúndio, com apenas a primeira em maiúscula também (exceto nomes próprios).

Exemplos de títulos:

• Cadastro de Template de WhatsApp
• Cadastro de template de WhatsApp
• Como cadastrar um template de WhatsApp?
• Cadastrando um template de WhatsApp

Heading 2 em diante

Utilize sempre a primeira letra maiúscula, o restante fica em letras minúsculas (exceto nomes próprios).

• Cadastrando um template simples para o WhatsApp
• Templates compostos do WhatsApp

Títulos, subtítulos e nomes de campos nos produtos

Utilize sempre a primeira letra maiúscula, o restante fica em letras minúsculas (exceto nomes próprios). Exemplos:

• Cadastro de templates
• Gerenciamento de templates
• Nome do template
• Data de nascimento

Nomes de produtos e/ou funcionalidades

Quando nos referimos a produtos e/ou funcionalidades específicas, devemos escrever todas as primeiras letras, de todas as palavras, em maiúsculas, pois estamos falando de nomes próprios. Exemplos:

• Zenvia Message
• Zenvia Chat
• Atualização Cadastral
• Cadastro de Templates
• Gerenciamento de Templates

Nome de arquivos

Extensões e formatos de arquivos devem ser grafados de acordo com os seguintes critérios:

• quando for extensão, o correto é .csv, .pdf, .doc, etc.;
• quando for o formato do arquivo, o correto é CSV, PDF, DOC, JPG, MP3, etc.

Depois de dois-pontos

Observe o uso de maiúsculas e minúsculas depois de dois-pontos. Quando, depois do : (dois-pontos), há uma frase completa, com sujeito, verbo e objeto, ela começa com inicial maiúscula. Caso contrário, inicia-se com minúscula (geralmente em explicação de termos). Exemplos:

• Indicador: Este botão permite que o gestor visualize a produtividade dos colaboradores.
• Indicador: permite que o gestor visualize a produtividade dos colaboradores.

Ordem direta da frase

Deixe as frases completas e prefira a ordem direta: Sujeito + verbo + complemento. Exemplos:

• ❌ Liberada nova funcionalidade.
• ✔️ Uma nova funcionalidade, que permite a configuração de templates, foi liberada.
• ✔️ Foi liberada uma nova funcionalidade que permite a configuração de templates.

Tempo e modo

Nos manuais, textos em geral, o tempo verbal a ser utilizado deve ser o presente.

⚠️ Em release notes, utilizamos verbos no passado, pois trata-se de melhorias/correções já realizadas e que já estão em operação no sistema.

Observe os exemplos abaixo. Veja que podemos falar de 3 maneiras.

1. De forma neutra;
2. Na primeira pessoa do plural (nós), se colocando como parte integrante do processo;
3. Na segunda pessoa do singular (você / tu), falando diretamente com o leitor.
• ✔️ (1) Aqui é possível realizar o cadastro de templates.
• ✔️ (2) Aqui conseguimos realizar o cadastro de templates.
• ✔️ (3) Aqui você pode realizar o cadastro de templates.

💡 Utilize sempre uma dessas formas. No entanto, tome cuidado em alguns contextos em que a documentação vai servir para vários leitores e nem todos vão fazer o mesmo processo. Então, não conseguimos utilizar o “você”, já que, nesse caso, os leitores são múltiplos ou você está explicando o processo para um terceiro (analista da Zenvia, por exemplo).

💡 Quando há passo a passo, usamos o verbo no imperativo: “Clique”, “Acesse”, “Faça o login”. No tópico de marcadores e numeração, temos um exemplo.

Marcadores e numeração

Quando houver passo a passo, usamos numeração para tornar mais didático.

Como criar um ramal?

1. Acesse o painel Voz.

2. Clique no menu Central > Ramais. Serão mostrados os ramais já existentes na conta.

3. Depois, clique em Criar ramal. Aparecerá uma tela como na imagem a seguir.

Quando houver uma lista de coisas, também usamos os marcadores. Veja mais um exemplo.

Aqui temos um ponto bem importante, pois você deve decidir se vai usar uma mensagem simples ou uma mensagem com cabeçalho, mídia, rodapé e botões.

• A mensagem simples pode conter variáveis e possui o limite de 1024 caracteres.
• Já a mensagem composta permite apenas 160 caracteres no corpo do template.

Sequência de cliques

Sempre que houver uma sequência de cliques em menus, descreva os passos separados por >. Não é necessário usar itálico quando houver >. Exemplo:

✔️ Para fazer o disparo de mensagens, acesse: Produtos > Zenvia Message > Canais > WhatsApp.

Pontuação

Ponto final

Utilize ponto final em todas as frases. Não utilize ponto final em títulos, subtítulos e botões.

Vírgula

Em geral, use vírgula quando uma parte do complemento estiver deslocada (sem ordem direta). Saiba mais.

Exemplos:

✔️ Caso seja necessária a autorização do gestor, marque a opção X.

OU

✔️ Marque a opção X caso a autorização do gestor seja necessária.

Use menos vírgulas e mais pontos! Textos com mais de 1 linha, coloque ponto final. Exemplos:

❌ Agora o sistema permite inserir variáveis em todos os campos de texto do template, desde que o limite de caracteres da mensagem não seja ultrapassado, senão ocorrerá um erro no envio.

✔️ Agora você pode utilizar variáveis em todos os campos de texto do template. Caso a variável ultrapasse o limite de caracteres da mensagem, ocorrerá um erro no envio.

Ponto e vírgula

O sinal de ponto e vírgula deve ser utilizado em uma lista vertical de itens, na qual cada item ocupa uma linha.

Utilizamos ponto e vírgula após cada um dos itens e ponto final após o último, conforme exemplo abaixo.

Canais de comunicação da Zenvia:

• WhatsApp;
• SMS;
• Voz;
• Web Chat;
• Facebook;
• RCS.

Caso a frase ultrapasse uma linha, usamos ponto final após todos os itens desta lista.

Exemplo:

Os tipos de mensagem são os seguintes:

• A mensagem simples pode conter variáveis e possui o limite de 1024 caracteres.
• Já a mensagem composta permite apenas 160 caracteres no corpo do template.

Números

Dentro de frases ou títulos utilize sempre o número (não é necessário escrever por extenso). Exemplos:

• ✔️ 5 palavras
• ✔️ 34 cores
• ❌ Cinco palavras
• ❌ Trinta e quatro cores

Itálico

Nas documentações, nomes de botões, módulos, áreas, funções são em itálico. Nos produtos, os nomes não levam nenhum destaque. Exemplo:

Cadastrar templates dentro da plataforma Zenvia é fácil e intuitivo. Para começar, acesse app.zenvia.com, clique em Produtos, depois em WhatsApp e, então, em Templates.

Negrito

O negrito pode ser usado para destaque, como em nomes de arquivos. Exemplo:

Em C:\Program Files\Google\Chrome\Application, abra o arquivo chrome.

Aspas

As aspas só são utilizadas quando estamos citando um erro, uma mensagem. Exemplo:

Ao cadastrar um template, o seguinte aviso era exibido: “Não foi possível cadastrar este template.”.

⚠️ Não utilize aspas para nomes de campos, menus, etc. O itálico deve ser usado neste caso.

Siglas

As siglas são junções de letras, que formam ou não uma palavra, e representam o nome abreviado de uma instituição. A indicação é escrever a palavra por extenso e a sigla entre parênteses em uma primeira citação no texto. Posteriormente, podemos usar a versão curta quantas vezes quisermos ao longo do texto. Escrevemos siglas com até três letras, com todas as letras maiúsculas. Já em siglas com quatro letras ou mais, somente a primeira é maiúscula e as demais minúsculas. Seguem exemplos de cada uso.

• Associação Brasileira de Normas Técnicas (ABNT);
• OAB - Ordem dos Advogados do Brasil;
• Senai - Serviço Nacional de Aprendizagem Industrial.

Palavras comuns

Termos que aparecem frequentemente em nossos produtos e manuais.

• Área / Seção = lugar com mais de um campo.
• Campo = pode ser checkbox, combobox, entre outros. É um elemento único.
• Botão = ligado a uma ação, ABRIR, FECHAR etc. Possui uma caixa que o identifica.
• Menu = local onde o sistema é acessado. Geralmente, contém várias funcionalidades.
• Opção = usa-se como sinônimo para campo, mas também para denominar a seleção dentro do campo.
• Aba = parte que contém várias áreas e/ou campos.
• Coluna = mesmo conceito de planilha Excel.
• Linha = mesmo conceito de planilha Excel.
• Tabela = mesmo conceito de planilha Excel. Também pode ser chamado de grid ou grade.
• Janela / Pop-up = tela pequena que aparece geralmente com um aviso.
• Modal = tela pequena que contém instruções.

Padronização visual

Cor e fonte

A cor e a fonte utilizadas nas páginas são as padrões da plataforma (Central de Ajuda). Fonte no formato Heading 2 para títulos dentro da página, Heading 3 e 4 para subtítulos e Paragraph na descrição de conteúdo.

Formatação do texto

Fonte e tamanho:

• Fonte utilizada atualmente é a fonte padrão da Movidesk: Roboto 11.

• Títulos das seções e subseções: Utilizar cabeçalho 1, 2 e 3 para criar seções e subseções no decorrer do texto, a depender da arquitetura de informação da documentação.

• TBD: Como cada cabeçalho será utilizado?

  • Cabeçalho 1:
  • Cabeçalho 2:
  • Cabeçalho 3: negrito, mesma fonte do corpo do texto.

• O ideal seriam 3 níveis com título.



• Observação: Título do artigo e títulos das seções e subseções: Utilizar letra maiúsculaapenas no início da frase, exceto se houver nome de produtos ou equivalentes no corpodo título. Não utilizar ponto final.

Alinhamento:

• Alinhamento utilizado atualmente: à esquerda.
• Cor do texto: Preto (a não ser que seja um hiperlink. Checar Formatação de links).
• Destaque de itens de menu, botões, nomes de teclas e arquivos: Negrito.
• Em sequências de cliques em menus, descrever passos separados por > e os botões serão destacados em negrito como em todos os outros casos de destaque de botão.
• Destaque para palavras em outro idioma: Itálico. No entanto, caso a palavra em outro idioma seja um produto Zenvia (exemplo Zenvia Attraction) não há necessidade do itálico, por tratar-se de um nome próprio.
• Números: Escrever por extenso os números de um a dez. Escrever numerais a partir do 11.
• Tempo verbal e gênero: Utilizar verbos no imperativo e no tempo presente.
• Voz: Utilizar voz ativa (ordem direta: Sujeito + verbo + complemento)

Exemplos:

❌ Liberada nova funcionalidade.

✔️ Uma nova funcionalidade, que permite a configuração de templates, foi liberada.

• Listas: Use uma lista com marcadores para itens não ordenados; use uma lista numerada para itens ordenados. Em outras palavras: Se você reorganizar os itens em uma lista com marcadores, o significado da lista não será alterado. Se você reorganizar os itens em uma lista numerada, o significado da lista muda.

  • Exemplo de lista numerada: [Para descrever processos e passo-a-passo de funcionalidade]

Exemplo: Como criar um ramal?

1. Acesse o painel Voz.

2. Clique no menu Central > Ramais. Serão mostrados os ramais já existentes na conta.

3. Depois, clique em Criar ramal. Aparecerá uma tela como na imagem a seguir.

• Exemplo de lista com marcadores:

  • Observação: No caso de listas com marcadores, deve ser selecionada a opção Círculo pois a opção automática Padrão está com bug devido a migração ter sido feita via bot com cópia do código fonte da Wix.



• Observação: O sinal de ponto e vírgula deve ser utilizado em uma lista vertical de itens, na qual cada item ocupa uma linha. Terminar os passos intermediários com ponto e vírgula e o último passo com ponto final.

Exemplo: Canais de comunicação da Zenvia:

• WhatsApp;
• SMS;
• Instagram;
• RCS;
• Voz;
• Web Chat;
• Messenger;

• Após dois pontos: Quando, depois do : (dois-pontos), há uma frase completa, com sujeito, verbo e objeto, ela começa com inicial maiúscula. Caso contrário, inicia-se com minúscula (geralmente em explicação de termos).

  • Exemplos:
  • ✔️ Indicador: Este botão permite que o gestor visualize a produtividade dos colaboradores.
  • ✔️ Indicador: permite que o gestor visualize a produtividade dos colaboradores.
  • Emojis: Os únicos emojis que devem ser utilizados são os listados abaixo:
    • 💡: Dica
    • ⚠️: Aviso/Atenção
    Exemplo:

    

Código de cor:?

❌: Melhor evitar

✔️: Recomendado

Exemplo:



• Padrão para notas (Dica, Atenção): Definir antes do conteúdo a ser apresentado na nota se o texto se trata de uma dica ou atenção.

  • Dica: O termo deve vir destacado em verde, em negrito e deve acompanhar o emoji 💡.
  • Atenção: O termo deve vir destacado em vermelho, em negrito e deve acompanhar o emoji ⚠️.

Exemplo:



• Observação: A escolha das cores se deu levando em consideração o padrão de cores utilizado pelo squad de Design System Zenvia. De acordo com o Feedback colors deste padrão, o verde (Success Color) é uma das cores de feedback do sistema, normalmente relacionada a feedbacks de sucesso, conclusão ou positivos no geral. Enquanto isso, o vermelho (Danger Color) geralmente está relacionado a erros ou ações destrutivas, seu uso é associado a feedbacks de erro.

Esta cor tem um uso mais restritivo em relação as outras, focando em elementos negativos.

• Código hexadecimal da cor verde: #D3EDD6
• Código hexadecimal da cor vermelha: #F1D3D8

Formatação de imagens

• Salve imagens sempre em formato PNG.
• O botão ou área a ser evidenciado deve ser destacado em vermelho.
• Em artigos em que você demonstra como acessar uma solução/ferramenta/canal, utilize capturas de tela que mostram a tela na íntegra, incluindo o menu superior.
• Em artigos que você descreve um passo a passo que não inclui navegação no menu superior, este menu deve ser cortado e todo o restante da tela deve aparecer na imagem.
  • Esta decisão foi tomada para evitar o retrabalho dos TWs. Atualmente, pequenos ajustes no menu exigem atualização de todos os screenshots. Por isso, o menu será cortado quando sua aparição não afetar a descrição do passo a passo.

Exemplo:



• Caso o passo a passo exija muitas imagens, considere criar um gif para acoplar várias telas em uma única imagem.

  • Este site gratuito pode ser utilizado para criação de gifs. Caso não saiba criar gifs, consulte este tutorial.

• Não é necessário acrescentar legendas as imagens, pois antes das capturas de tela, existe uma explicação de passo a passo detalhada, de forma que a legenda se faz desnecessária e sua existência seria uma redundância.

Formatação dos links

Substituir links inteiros extensos por hiperlinks.

Exemplo:

❌Para realizar um envio por arquivo no Connect da Zenvia, assista nosso rápido vídeo tutorial: https://www.youtube.com/watch?v=6mHsPA5MTiw&feature=youtu.be.

✔️ Para realizar um envio por arquivo no Connect da Zenvia, clique aqui e assista nosso vídeo tutorial.

• Caso o link leve o usuário para uma página exterior ao artigo que está acessando, o campo Alvo deve ter selecionada a opção Nova Janela.



• Caso o link leve um usuário para uma outra seção naquela mesma página, deve-se utilizar a funcionalidade Âncora.



• Automaticamente, hiperlinks serão sublinhados na cor azul.

Emojis

Utilizamos alguns emojis, com bom senso, para destacar algumas informações e ajudar na leitura.

1. Para destacar uma informação importante, uma nota, uma configuração, etc.: ✔️
2. Para destacar um requisito ou uma configuração sem a qual o recurso do sistema não funciona, para informar restrições: ⚠️
3. Para dar uma dica ao usuário, sobre algo que gere um benefício, para indicar uma documentação complementar, um link: 💡

Alerta de página em construção

O usuário deve ser alertado se uma página está em construção.

⚠️ Conteúdo em construção.

Recursos da plataforma

Para que a leitura seja otimizada, podemos utilizar alguns recursos da Central, sempre com bom senso.

Headings

É importante dividir as informações para que o leitor possa se encontrar na página. Veja um exemplo aqui de divisão.

Destaques

Também podemos usar o recurso Informative para destacar informações importantes. Exemplo aqui.

Linhas

Utilize as linhas para separar blocos de conteúdo. Exemplo aqui.

Tabelas

Também podemos usar a tabela. Exemplo.

GIFs Os GIFs facilitam a assimilação do conteúdo. Veja exemplo.

💡 Não utilize gifs muito longos. Se tiver muitas etapas, separe em gifs com uma duração menor. Além disso, procure deixar com uma velocidade que seja possível acompanhar. Se deixar muito rápido, o usuário terá de ver várias vezes para entender.

Labels

É possível configurar algumas palavras-chave para quando o usuário digitar no campo de pesquisa, aparecer esse artigo como sugestão. Essas palavras devem ser inseridas em Labels.



Artigos relacionados

É interessante correlacionar artigos que têm coisas em comum, ajudando o usuário a navegar pelo conteúdo. Isso pode ser feito em Related Articles.



---

Inspirações, fontes e mais conteúdo

Para se inspirar:

• Conta Azul, Guia de Redação, https://guiaderedacao.contaazul.design/4c03672f6/p/47bee2-guia-de-redao
• Mail Chimp, Guia de Conteúdo,: https://styleguide.mailchimp.com/
• Google, Guia de Estilo de Documentação do Desenvolvedor: https://developers.google.com/style/

Para refletir:

• Ugur Akinci, Artigo: https://www.linkedin.com/pulse/7-features-good-technical-writing-ugur-akinci/
• Thaís Costa, Artigo: https://comunidade.rockcontent.com/linguagem-neutra-de-genero/
• André Fischer, Manual Prático da Linguagem Inclusiva: https://irp-cdn.multiscreensite.com/87bdaac3/files/uploaded/mpli1_2.pdf

Para escrever melhor:

• Classe de palavras: https://brasilescola.uol.com.br/gramatica/classes-palavras.htm
• Termos da oração: https://www.todamateria.com.br/termos-integrantes-da-oracao/
• Ordem direta: http://www.conteudoseducar.com.br/conteudos/arquivos/4347.pdf
• Adjunto adnominal e complemento nominal: https://www.normaculta.com.br/adjunto-adnominal-e-complemento-nominal/
• Regência: https://www.normaculta.com.br/regencia-verbal-e-nominal/
• Concordância nominal: https://www.todamateria.com.br/concordancia-nominal/
• Concordância verbal: https://www.todamateria.com.br/concordancia-verbal/
• Vírgula: https://www.normaculta.com.br/virgula/
• Adjunto adverbial deslocado: https://www12.senado.leg.br/manualdecomunicacao/redacao-e-estilo/estilo/adverbio-deslocado
• Crase:
  • https://www.normaculta.com.br/uso-da-crase/
  • https://www.acheconcursos.com.br/artigo/crase-regras-de-quando-usar#:~:text=Antes%20dos%20pronomes%20possessivos%20femininos,devo%20respostas%20a%20minha%20professora%22
• Gerúndio, gerundismo: https://brasilescola.uol.com.br/gramatica/diferencas-entre-gerundio-gerundismo.htm
• Pleonasmo: https://www.portugues.com.br/gramatica/pleonasmo.html
• Porquês: https://brasilescola.uol.com.br/gramatica/por-que.htm