Planos que suportam este recurso: Professional Business Enterprise
Você pode reutilizar variáveis quando usa o mesmo conteúdo baseado em texto em vários lugares que podem mudar ao longo do tempo (como nomes de campos, números de contato, endereços, avisos, etc.). Uma Variável no Document360 é um elemento reutilizável que ajuda a manter consistência e eficiência entre várias seções de documentação. Ao empregar variáveis, os colaboradores dos seus artigos podem atualizar facilmente as informações em um único lugar, e elas se refletem automaticamente em toda a documentação, garantindo precisão e reduzindo esforços redundantes.
Por exemplo, você quer adicionar suas informações de contato em várias ocasiões, o que pode mudar com o tempo. Nesse caso, você pode adicionar uma variável para as informações de contato. Se for necessária uma alteração, você pode atualizar a variável sozinha, em vez de atualizá-la em todas as ocasiões.
Página de variáveis
Você pode visualizar, editar ou excluir variáveis na página Variáveis .
Para acessar a página Variáveis :
Navegue até Ferramentas de conteúdo (
) na barra de navegação da esquerda no Portal da base de conhecimento.No painel de navegação à esquerda, navegue até Recursos de conteúdo > Variáveis.
A página Variáveis aparece, onde você pode encontrar a lista de Variáveis que já adicionou.
A página Variáveis se abre, exibindo a lista de variáveis existentes (se houver).
Como fazer: Clique para ver um tutorial sobre como usar variáveis.
Documentação: Clique para abrir o artigo de documentação sobre variáveis.
Criar: Clique para criar uma nova variável.
Idiomas: Filtre as variáveis por Global ou por uma linguagem específica.
Variável de busca: Use esta para buscar uma variável pelo nome.
Variável selecionada: Use a caixa de seleção para selecionar uma ou mais variáveis para realizar a operação de exclusão em massa. Clique no nome da variável para visualizar o conteúdo.
Usado em:
Se uma variável não for usada em qualquer página de artigo ou categoria, um hífen (-) aparece.
Se for usado, clique em Visualizar para ver uma lista de artigos ou categorias onde ele aparece.
Linguagem: Mostra a linguagem para cada variável.
Última modificação: Mostra a data e hora da última atualização da variável.
Tradução: Clique no ícone do globo para ver o progresso da tradução da variável. Clique no ícone globo () ao lado de cada variável. A indica que a variável foi traduzida para esse idioma, enquanto o ícone indica que ainda não foi traduzida.
Editar (): Clique para editar o conteúdo variável. Após editar, clique em Atualizar.
Excluir (): Clique para excluir uma variável. Para excluir várias variáveis em uma única instância, selecione a caixa desejada e clique em Delete no topo.
Criar uma variável
Para criar uma variável:
Navegue até Ferramentas de conteúdo (
) na barra de navegação da esquerda no Portal da base de conhecimento.No painel de navegação à esquerda, navegue até Recursos de conteúdo > Variáveis.
Na página de Variáveis , clique em Criar no canto superior direito.
Digite o nome da variável.
NOTA
Nomes de variáveis podem incluir letras, números, hífens e sublinhas. O nome não deve exceder 50 caracteres.
O valor do código Merge será o nome da variável que aparece com a tag da variável no seu editor.
Por exemplo, se o nome da sua variável for
Disclaimer, o código de mescagem é{{variable.Disclaimer}}.Do menu suspenso de Idioma :
Por padrão, a seleção é Global (aplica-se a todos os idiomas).
Você também pode selecionar uma linguagem específica para criar uma variável específica para cada idioma.
No campo Conteúdo , insira a variável conteúdo.
NOTA
O limite de conteúdo variável é de 300 caracteres, incluindo espaços. Para textos ou mídias mais longas, use Snippets.
Opções de formatação
Você pode estilizar seu conteúdo variável usando as seguintes ferramentas de formatação:
Família de fontes (): Altere a família de fontes do texto.
Tamanho da fonte: Ajuste o tamanho do texto entre 8 e 48.
Negrito () Enfatize palavras ou frases importantes.
Itálico (): Destaque texto ou indique termos como variáveis ou títulos.
Sublinhar (): Adicione uma linha abaixo do texto para dar ênfase.
Cor do texto: Mude a cor do texto usando um seletor de cor ou código HEX.
Cor de fundo: Mude a cor de fundo atrás do texto.
Clique no menu Mais () para acessar opções adicionais:
Código inline (): Formatar trechos curtos de código ou comandos dentro do texto.
Riscar (): Riscar o texto para indicar remoção ou revisão.
Sobrescrito (): Exiba texto um pouco acima da linha (útil para notas de rodapé ou matemática).
Subscrito (): Exiba texto um pouco abaixo da linha (útil para fórmulas).
Remover formatação (): Limpar todos os estilos aplicados e voltar ao texto simples.
Inserir link (): Adicionar um hiperlink ao texto. Você pode linkar para outro artigo dentro do seu projeto ou para uma URL externa. Isso funciona da mesma forma que o hiperlink de texto no editor avançado WYSIWYG.
LaTeX (): Adicionar expressões LaTeX para conteúdo matemático.
Emoji (): Insira emojis no conteúdo.
NOTA
Você pode usar o
/menu Barra no editor de variáveis para acessar ferramentas de formatação como Cabeçalho 3 e Cabeçalho 4, e também pode inserir elementos como Link, LaTeX e Emoji.
Uso de variável em uma página de artigo/categoria
Você pode adicionar uma variável à página do seu artigo/categoria usando três métodos.
Método 1: Uso da sintaxe (editor Markdown)
Método 2: Da barra de ferramentas (Markdown, WYSIWYG e Advanced WYSIWYG)
Método 3: Usando o comando barra (/)
Método 1: Uso da sintaxe (editor Markdown)
No editor Markdown, digite uma variável. MergeCodeValue entre parênteses duplos fechados.
Exemplo: {{variável. Aviso}}
Você precisa saber o valor exato do código de mescagem para adicionar a variável desejada. A variável não vai funcionar mesmo que uma única letra mude.
NOTA
Digitando variável. Merge_Code_Value só funcionará no editor Markdown. Se você estiver usando Advanced WYSIWYG editor, pode inserir uma variável usando a barra de ferramentas.
Método 2: Da barra de ferramentas (Markdown, WYSIWYG e Advanced WYSIWYG)
Clique no ícone Recursos de conteúdo para Markdown
e editor WYSIWYG.
(ou)
A partir do editor avançado WYSIWYG, use o comando/variablesbarra para acessar variáveis.
Selecione a variável ou use a barra de variáveis de Busca para restringir o nome da variável.
No editor avançado WYSIWYG, o painel de Variáveis aparece para seleção de variáveis. Passe o mouse no nome da variável desejada para pré-visualizar seu conteúdo.
Selecione a variável pretendida a inserir.
NOTA
No editor Markdown e WYSIWYG, você pode selecionar várias variáveis de uma vez.
Método 3: Usando o comando barra (/)
Use o comando
/variablesbarra para abrir a opção Variáveis no menu de barra.Procure ou selecione a variável que você quer inserir. Passe o mouse sobre uma variável para pré-visualizar seu conteúdo completo.
Clique na variável para inseri-la.
A variável inserida exibe o conteúdo real da variável com um sublinhado pontilhado no editor. Isso permite que você veja o valor real da variável durante a edição.
Clique na variável inserida para abrir o menu de bolhas, onde você pode:
Troque para outra variável usando o menu suspenso.
Inserir como texto, que substitui a variável por seu conteúdo como texto estático.
Remova a variável do artigo.
Ver dependência da página do artigo/categoria
Na página Variáveis, você pode encontrar a coluna Usado em.
Na coluna Usado em , clique no botão Visualizar .
O painel Visualizar referências aparecerá, onde você pode visualizar a lista de artigos/páginas de categoria às quais a variável foi adicionada.
Clique no artigo para expandir a seção.
Você pode encontrar as seguintes informações:
A versão do artigo.
O espaço de trabalho e a linguagem do projeto.
O nome da conta do time e a foto de perfil que adicionaram a variável.
O artigo afirma (Rascunho e Publicado).
A informação de hora/data em que a variável foi inserida na página do artigo/categoria.
Editando uma variável existente
Para editar uma variável existente:
Navegue até Ferramentas de conteúdo (
) na barra de navegação da esquerda no Portal da base de conhecimento.No painel de navegação à esquerda, navegue até Recursos de conteúdo > Variáveis.
A página de Variáveis vai aparecer. Você pode encontrar a lista de variáveis que já adicionou.
Passe o mouse sobre a variável desejada e clique no ícone Editar ().
Você pode editar o conteúdo da variável. O Nome e o Valor do Código de Fusão não podem ser editados.
NOTA
Editar um link adicionado em uma variável
Clique no link e você encontrará as seguintes opções:
Abrir o link (): O link será aberto na aba. Isso ajuda a verificar o link.
Edit (): Para editar a URL, linke o texto e mudar a opção de abrir na nova aba.
Desvincular (): Para desvincular a URL e mudá-la para texto padrão. A URL será desvinculada, e apenas o texto da URL aparecerá.
Copiar (): Para copiar o link.
Depois de concluir a edição de conteúdo, clique no botão Atualizar .
NOTA
Quando você edita o conteúdo de uma variável existente na biblioteca, a alteração de conteúdo será refletida em todos os artigos/páginas de categoria que contêm a respectiva variável.
Deletação de uma variável
Para excluir uma variável,
Navegue até Ferramentas de conteúdo (
) na barra de navegação da esquerda no Portal da base de conhecimento.No painel de navegação à esquerda, navegue até Recursos de conteúdo > Variáveis.
A página de Variáveis vai aparecer. Você pode encontrar a lista de variáveis que já adicionou.
Passe o mouse sobre a variável desejada e clique no ícone Excluir ().
Clique em sim na janela de confirmação de Exclusão .
Para excluir em massa múltiplas variáveis
Selecione várias variáveis pretendidas na página de Variáveis e clique na opção Excluir no topo da lista.
NOTA
Quando você exclui uma variável, ela é removida de todos os artigos onde ela é referenciada.
O artigo em si não é modificado nem republicado quando uma variável é excluída.
No site da base de conhecimento, o conteúdo ao redor se ajusta automaticamente, então não resta espaço vazio onde a variável foi removida.
No portal, a variável é substituída pelo texto provisório "Carregando...". Você pode substituir isso por outra variável ou deletar manualmente.
Variáveis de tradução
Você pode criar e gerenciar variáveis em vários idiomas. Isso garante que, quando seus artigos são traduzidos, as variáveis correspondam ao idioma do artigo, proporcionando uma experiência de usuário consistente e localizada.
Tradução de novas variáveis
Navegue até Ferramentas de conteúdo (
) na barra de navegação da esquerda no Portal da base de conhecimento.No painel de navegação à esquerda, navegue até Recursos de conteúdo > Variáveis.
Clique em Criar.
No menu suspenso Idioma , selecione o idioma pretendido (exceto global).
Insira o nome da variável e o conteúdo da variável em inglês (ou no seu idioma padrão).
Para traduzir o conteúdo para outros idiomas, clique no menu suspenso Traduzir para outros idiomas .
Selecione os idiomas desejados no menu suspenso e clique em Traduzir.
NOTA
O idioma padrão será marcado como Principal.
Os idiomas traduzidos serão indicados com um visto verde para indicar que a tradução está completa. Se necessário, você pode navegar para idiomas não traduzidos e completar a tradução deles.
Quando as traduções estiverem concluídas, clique em Salvar para salvar a variável junto com suas traduções.
Por exemplo, se você criar uma variável para uma mensagem de boas-vindas em inglês, pode usar o recurso de tradução para adicionar a mesma mensagem em francês, espanhol, alemão, etc.
Tradução de variáveis existentes
IMPORTANTE
Variáveis globais não podem ser traduzidas.
Navegue até Ferramentas de conteúdo (
) na barra de navegação da esquerda no Portal da base de conhecimento.No painel de navegação à esquerda, navegue até Recursos de conteúdo > Variáveis.
Clique na variável desejada que deseja transferir.
Navegue para Traduzir para outros idiomas e selecione o idioma desejado para o qual a variável precisa ser traduzida.
Clique em Traduzir.
Se necessário, você pode navegar para outros idiomas e traduzi-los.
Para retraduzir o conteúdo, clique em Traduzir novamente, o que substituirá a tradução existente pela nova.
Se precisar remover a variável traduzida de um idioma específico, clique no ícone Mais () e selecione Remover idioma.
Você pode retraduzir o conteúdo a qualquer momento, se necessário.
Depois de terminar, clique em Atualizar.
Perguntas Freqüentes
Como funcionam as variáveis?
As variáveis permitem que você defina elementos específicos de conteúdo, como nomes de produtos ou números de versão, em um único lugar. Atualizar a variável reflete automaticamente a mudança em todas as seções relevantes quando esse conteúdo muda, garantindo uniformidade.
Qual é o benefício de usar Variáveis na minha documentação?
Ao usar Variables, você garante consistência na sua documentação enquanto minimiza a necessidade de atualizações manuais. Isso economiza tempo, reduz erros e mantém a precisão, especialmente ao lidar com informações que mudam frequentemente.
Posso criar minhas variáveis no Document360?
O Document360 permite que você crie variáveis personalizadas adaptadas às suas necessidades de documentação. Isso permite que você adapte o recurso à terminologia e aos elementos específicos relevantes para seu conteúdo.
Como uso Variáveis nos meus artigos?
Insira a variável no conteúdo do artigo usando a barra de ferramentas do editor ou o valor do código de mescagem, e ele irá puxar dinamicamente as informações que você definiu, garantindo uniformidade em toda a sua documentação.
As variáveis podem ser atualizadas em vários artigos ao mesmo tempo?
Quando você atualiza uma variável, a mudança é automaticamente refletida em todas as instâncias em que essa variável é usada, facilitando a manutenção de informações consistentes em toda a sua base de conhecimento.
As variáveis são limitadas a tipos específicos de conteúdo?
Sim, as variáveis podem ser usadas para conteúdo limitado baseado em texto, números ou links, desde nomes de produtos e números de versão até URLs e informações de contato.
Como as variáveis melhoram a colaboração entre os membros da equipe?
As variáveis simplificam o processo de colaboração garantindo que todos estejam usando as mesmas informações precisas. Alterações em uma variável são atualizadas instantaneamente em todos os artigos, evitando discrepâncias.
Usar variáveis é uma boa prática na documentação técnica?
O uso de variáveis é uma boa prática que melhora a eficiência, consistência e precisão da documentação técnica. É especialmente valioso ao trabalhar com informações dinâmicas que exigem atualizações frequentes.
Posso traduzir variáveis para qualquer idioma?
Você pode traduzir variáveis para qualquer idioma do seu projeto.
A definição de um termo variável criada no site da base de conhecimento é indexada na busca e pelo Google?
Sim, a definição de um termo variável criado no site da Knowledge Base (KB) é indexada tanto na busca do site quanto pelo Google. Uma vez que o termo é adicionado, ele se torna pesquisável no site e também será rastreado e indexado pelo Google.