Variáveis são elementos de texto reutilizáveis que permitem definir um valor uma vez e inseri-lo em vários artigos e páginas de categoria. Quando o valor muda, você atualiza a variável em um só lugar e todo artigo que o usa atualiza automaticamente.
Por exemplo, se seu e-mail de suporte aparecer em 40 artigos e mudar, atualizar a variável uma vez atualiza todos os 40 artigos instantaneamente.
Quando usar variáveis
Use variáveis para conteúdos curtos baseados em texto que:
- Aparece em vários artigos ou páginas de categorias.
- É provável que mude com o tempo, como dados de contato, números de versão, nomes de produtos, URLs, rótulos de campos ou avisos de responsabilidade.
- É preciso manter a consistência em toda a base de conhecimento.
Para conteúdos mais longos ou formatados, como parágrafos, tabelas, destaques ou imagens, use Snippets em vez disso.
Variáveis vs. trechos
| Variáveis | Trechos | |
|---|---|---|
| Tipo de conteúdo | Texto simples, números, links, frases curtas. | Blocos formatados como parágrafos, tabelas, imagens, callouts e código. |
| Uso típico | Nomes dos produtos, números de versão, e-mails de suporte. | Avisos, passos compartilhados, bloqueios de contato, avisos repetidos. |
| Limite de caracteres | 300 caracteres. | Sem limite de caracteres. |
| Suporte à formatação | Formatação básica apenas em linha. | Formatação completa do editor. |
| Inserido via | Barra de ferramentas, sintaxe de mesclar código ou comando de barra. | Sintaxe de código de barra de ferramentas ou mescagem. |
Comece com variáveis
Criar e gerenciar variáveis
Crie uma variável e configure seu nome, mesture código, linguagem e conteúdo. Editar, excluir, excluir em massa e visualizar dependências de artigos.
Saiba mais →Uso e tradução de variáveis
Insira variáveis nos artigos usando a barra de ferramentas, mesclar a sintaxe do código ou o comando de barra. Traduza variáveis para bases de conhecimento multilíngues.
Saiba mais →Melhores práticas
- Use variáveis para conteúdo que muda, não para conteúdo que permanece fixo. Variáveis são mais valiosas quando o conteúdo precisa ser atualizado periodicamente. Se um valor dificilmente vai mudar, escrevê-lo em linha é mais simples e fácil de revisar.
- Use variáveis apenas quando o mesmo conteúdo aparece em três ou mais lugares. Se algo aparece em apenas um ou dois artigos, atualizá-los diretamente é mais rápido do que criar e gerenciar uma variável.
- Use nomes descritivos e específicos. Nomeie as variáveis para que os colaboradores possam identificar a correta rapidamente. Por exemplo,
SupportEmailouProductVersion_iOSé mais claro queemail1ouv1. Nomes vagos atrasam a autoria e levam à inserção da variável errada. - Defina o escopo da linguagem intencionalmente. Use Global para valores que são iguais em todos os idiomas, como um nome de produto que nunca é traduzido. Use variáveis específicas do idioma para valores que diferem conforme a localidade, como um número de telefone regional ou uma URL localizada.
- Verifique a coluna Usado em antes de editar ou excluir. Uma edição em uma variável atualiza imediatamente todos os artigos que a utilizam, incluindo os publicados. Antes de fazer uma alteração, revise quais artigos são afetados para verificar se o valor atualizado está corretamente lido em todos os contextos.
- Não use variáveis dentro dos trechos. Variáveis dentro de snippets não são renderizadas corretamente na prévia do editor ou nas exportações do PDF. Se um trecho precisa de valores dinâmicos, gerencie-os separadamente.