Planos que suportam este recurso: Professional Business Enterprise
Você pode reutilizar variáveis ao usar o mesmo conteúdo baseado em texto em vários locais que podem mudar ao longo do tempo (como nomes de campos, números de contato, endereços, avisos de isenção de responsabilidade etc.). Uma variável no Document360 é um elemento reutilizável que ajuda a manter a consistência e a eficiência em várias seções de documentação. Ao empregar variáveis, os colaboradores de seus artigos podem atualizar facilmente as informações em um só lugar e isso reflete automaticamente em toda a documentação, garantindo precisão e reduzindo esforços redundantes.
Por exemplo, você deseja adicionar suas informações de contato em várias instâncias, que podem mudar com o tempo. Nesse caso, você pode adicionar uma variável para informações de contato. Se uma alteração for necessária, você poderá atualizar a variável sozinha em vez de atualizá-la em todas as instâncias.
Página Variáveis
Você pode exibir, editar ou excluir variáveis na página Variáveis .
Para acessar a página Variáveis :
Navegue até Documentação () na barra de navegação esquerda no Portal da base de conhecimento.
No painel de navegação esquerdo, navegue até Ferramentas de conteúdo > Reutilização de conteúdo > Variáveis.
A página Variáveis é exibida, onde você pode encontrar a lista de variáveis que você já adicionou.
A página Variáveis é aberta, exibindo a lista de variáveis existentes (se houver).
Como fazer: Clique para ver um tutorial sobre como usar variáveis.
Docs: 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 um idioma específico.
Variável de pesquisa: use essa opção para pesquisar uma variável pelo nome.
Usado em:
Se uma variável não for usada em nenhum artigo ou página de categoria, um hífen (-) aparecerá.
Se for usado, clique em Exibir para ver uma lista de artigos ou categorias onde ele aparece.
Idioma: Mostra o idioma de cada variável.
Última modificação: Exibe a data e a hora em que a variável foi atualizada pela última vez.
Visualizar: Clique no nome da variável para visualizar seu conteúdo.
Progresso: clique no ícone de globo para visualizar o progresso da tradução da variável. Clique no ícone de globo () ao lado de cada variável. A indica que a variável foi traduzida para esse idioma, enquanto o ícone indica que ela ainda não foi traduzida.
Editar (): Clique para editar o conteúdo da variável. Após a edição, clique em Atualizar.
Excluir (): clique para excluir uma variável. Para excluir várias variáveis em uma instância, marque a caixa de seleção desejada e clique em Excluir na parte superior.
Criar uma variável
Para criar uma variável:
Navegue até Documentação () na barra de navegação esquerda no Portal da base de conhecimento.
No painel de navegação esquerdo, navegue até Ferramentas de conteúdo > Reutilização de conteúdo > Variáveis.
Na página Variáveis , clique em Criar no canto superior direito.
Insira o Nome da variável.
NOTA
Os nomes de variáveis podem incluir letras, números, hífens e sublinhados. O nome não deve exceder 50 caracteres.
O valor do código de mesclagem será o nome da variável que aparece com a tag de variável em seu editor.
Por exemplo, se o nome da variável for
Disclaimer, o código de mesclagem for{{variable.Disclaimer}}.No menu suspenso Idioma :
Por padrão, a seleção é Global (aplica-se a todos os idiomas).
Você também pode selecionar um idioma específico para criar uma variável específica do idioma.
No campo Conteúdo , insira a variável content.
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 o conteúdo da 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 o texto ou indique termos como variáveis ou títulos.
Sublinhado (): Adicione uma linha abaixo do texto para dar ênfase.
Cor do texto: altere a cor do texto usando um seletor de cores ou código HEX.
Cor de fundo: Altere a cor de fundo atrás do texto.
Clique no menu Mais () para acessar opções adicionais:
Código embutido (): Formate trechos de código curtos ou comandos dentro do texto.
Tachado (): risque o texto para indicar remoção ou revisão.
Sobrescrito (): exibe o texto ligeiramente acima da linha (útil para notas de rodapé ou matemática).
Subscrito (): exibe o texto um pouco abaixo da linha (útil para fórmulas).
Remover formatação (): Limpe todos os estilos aplicados e reverta para texto simples.
Inserir link (): Adicione um hiperlink ao texto. Você pode criar um link para outro artigo dentro do seu projeto ou para um URL externo. Isso funciona da mesma maneira que hyperlinking text no editor WYSIWYG avançado.
LaTeX (): Adicione 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 Título 3 e Título 4, e também pode inserir elementos como Link, LaTeX e Emoji.
Usando variável em uma página de artigo/categoria
Você pode adicionar uma variável à sua página de artigo/categoria usando três métodos.
Método 1: Usando a sintaxe (editor Markdown)
Método 2: Na barra de ferramentas (Markdown, WYSIWYG e WYSIWYG avançado)
Método 3: Usando o comando de barra (/)
Método 1: Usando a sintaxe (editor Markdown)
No editor Markdown, digite uma variável. MergeCodeValue entre chaves duplas fechadas.
Exemplo: {{variable. Isenção de responsabilidade}}
Você deve saber o valor exato do código de mesclagem para adicionar a variável desejada. A variável não funcionará mesmo se uma única letra for alterada.
NOTA
Digitando na variável. Merge_Code_Value só funcionará no editor Markdown. Se você estiver usando Advanced WYSIWYG editoro , poderá inserir uma variável usando a barra de ferramentas.
Método 2: Na barra de ferramentas (Markdown, WYSIWYG e WYSIWYG avançado)
Clique no ícone Reutilização de conteúdo () para o editor Markdown e WYSIWYG.
(ou)
No editor WYSIWYG avançado, use o comando/variablesde barra para acessar variáveis.Selecione a variável ou use a barra Pesquisar variáveis para restringir o nome da variável.
No editor WYSIWYG avançado, o painel Variáveis é exibido para seleção de variáveis. Passe o mouse sobre o nome da variável desejada para visualizar seu conteúdo.
Selecione a variável pretendida a ser inserida.
NOTA
No editor Markdown e WYSIWYG, você pode selecionar várias variáveis de uma só vez.
Método 3: Usando o comando de barra (/)
Use o comando
/variablesde barra para abrir a opção Variáveis no menu de barra.Pesquise ou selecione a variável que deseja inserir. Passe o mouse sobre uma variável para 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 balões, onde você pode:
Alterne 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.
Exibir dependência de página de artigo/categoria
Na página Variáveis , você pode encontrar a coluna Usado em .
Na coluna Usado em , clique no botão Exibir .
O painel Exibir 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 o idioma do projeto.
O nome da conta da equipe e a foto do perfil que adicionou a variável.
O artigo afirma (Rascunho e Publicado).
As informações de hora/data em que a variável foi inserida na página de artigo/categoria.
Editando uma variável existente
Para editar uma variável existente:
Navegue até Documentação () na barra de navegação esquerda no Portal da base de conhecimento.
No painel de navegação esquerdo, navegue até Ferramentas de conteúdo > Reutilização de conteúdo > Variáveis.
A página Variáveis será exibida. Você pode encontrar a lista de variáveis que você 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 mesclagem não podem ser editados.
NOTA
Editando um link adicionado em uma variável
Clique no link e você encontrará as seguintes opções:
Abrir link (): O link será aberto na guia. Isso ajuda a verificar o link.
Editar (): Para editar o URL, o texto do link e alterar a opção abrir na nova guia.
Desvincular (): para desvincular o URL e alterá-lo para texto padrão. O URL será desvinculado e somente o texto do URL será exibido.
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 do conteúdo será refletida em todos os artigos/páginas de categoria que contêm a respectiva variável.
Excluindo uma variável
Para excluir uma variável,
Navegue até Documentação () na barra de navegação esquerda no Portal da base de conhecimento.
No painel de navegação esquerdo, navegue até Ferramentas de conteúdo > Reutilização de conteúdo > Variáveis.
A página Variáveis será exibida. Você pode encontrar a lista de variáveis que você já adicionou.
Passe o mouse sobre a variável desejada e clique no ícone Excluir ().
Clique em Sim na caixa de diálogo Excluir confirmação.
Para excluir várias variáveis em massa
Selecione várias variáveis pretendidas na página Variáveis e clique na opção Excluir na parte superior da lista.
NOTA
Quando você exclui uma variável, ela é removida de todos os artigos em que é referenciada.
O artigo em si não é modificado ou republicado quando uma variável é excluída.
No site da base de dados de conhecimento, o conteúdo ao redor é ajustado automaticamente, portanto, nenhum espaço vazio permanece onde a variável foi removida.
No portal, a variável é substituída pelo texto de espaço reservado "Carregando...". Você pode substituí-la por outra variável ou excluí-la manualmente.
Traduzindo variáveis
Você pode criar e gerenciar variáveis em vários idiomas. Isso garante que, quando seus artigos forem traduzidos, as variáveis correspondam ao idioma do artigo, proporcionando uma experiência de usuário consistente e localizada.
Traduzindo novas variáveis
Navegue até Documentação () na barra de navegação esquerda no Portal da base de conhecimento.
No painel de navegação esquerdo, navegue até Ferramentas de conteúdo > Reutilização 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 idioma padrão).
Para traduzir o conteúdo para outros idiomas, clique no menu suspenso Traduzir para outros idiomas .
Selecione o(s) idioma(s) desejado(s) no menu suspenso e clique em Traduzir.
NOTA
O idioma padrão será marcado como Principal.
Os idiomas traduzidos serão indicados com uma marca verde para mostrar que a tradução foi concluída. Se necessário, você pode navegar para idiomas não traduzidos e concluir sua tradução.
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, poderá usar o recurso de tradução para adicionar a mesma mensagem em francês, espanhol, alemão etc.
Traduzindo variáveis existentes
NOTA
As variáveis globais não podem ser traduzidas.
Navegue até Documentação () na barra de navegação esquerda no Portal da base de conhecimento.
No painel de navegação esquerdo, navegue até Ferramentas de conteúdo > Reutilização de conteúdo > Variáveis.
Clique na variável desejada que deseja traduzir.
Navegue até Traduzir para outros idiomas e selecione o idioma desejado que a variável precisa traduzir.
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 você precisar remover a variável traduzida para um idioma específico, clique no ícone Mais () e selecione Remover idioma.
Você pode retraduzir o conteúdo a qualquer momento, se necessário.
Uma vez feito isso, clique em Atualizar.
Perguntas Freqüentes
Como funcionam as variáveis?
As variáveis permitem que você defina elementos de conteúdo específicos, como nomes de produtos ou números de versão, em um só lugar. A atualização da variável reflete automaticamente a alteração em todas as seções relevantes quando esse conteúdo é alterado, garantindo a uniformidade.
Qual é a vantagem de usar variáveis na minha documentação?
Ao usar variáveis, você garante consistência em sua documentação e 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 com frequência.
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 específica e aos elementos relevantes para o seu conteúdo.
Como faço para usar variáveis em 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 mesclagem, e ela extrairá 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 alteração é refletida automaticamente 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 dados 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úmero ou link, 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. As alterações em uma variável são atualizadas instantaneamente em todos os artigos, evitando discrepâncias.
O uso de variáveis é uma prática recomendada na documentação técnica?
O uso de variáveis é uma prática recomendada que melhora a eficiência, a consistência e a precisão da documentação técnica. É particularmente valioso ao trabalhar com informações dinâmicas que requerem atualizações frequentes.
Posso traduzir variáveis para qualquer idioma?
Você pode traduzir variáveis para qualquer um dos idiomas do seu projeto.
A definição de um termo variável criado no site da base de conhecimento é indexada na pesquisa e pelo Google?
Sim, a definição de um termo variável criado no site da Base de Conhecimento (KB) é indexada tanto na pesquisa do site quanto pelo Google. Depois que o termo é adicionado, ele se torna pesquisável no site e também será rastreado e indexado pelo Google.