Isenção de responsabilidade: Este artigo foi gerado usando tradução automática.

Variáveis

Prev Next

Planos compatíveis com a adição de variáveis

Profissional
Negócio
Empresa






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.
(Contato: +1 897564231/support@serverless.com)


Criando uma variável

Para criar uma variável,

  1. Navegue até Documentação () > Ferramentas de conteúdo > Reutilização de conteúdo > Variáveis no portal da base de dados de conhecimento.

    A página Variáveis é exibida. Se você adicionou alguma variável anteriormente, poderá vê-la listada aqui.

  2. Clique em Criar variável na parte superior para selecionar variáveis específicas do idioma (Global, inglês, francês, etc.) adicionadas ao seu projeto.

  3. Insira o Nome da sua variável.

NOTA

O nome da variável pode incluir letras, números, hífens e sublinhados, com um comprimento máximo de 30 caracteres.

  1. 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 Isenção de responsabilidade, o valor do código de mesclagem será {{variable. Isenção de responsabilidade}}.

  2. No menu suspenso Seleção de idioma , a seleção padrão é Global (disponível em todos os idiomas). No entanto, se necessário, você pode escolher um idioma disponível desejado para criar uma variável específica do idioma.

  3. No campo Conteúdo , insira o conteúdo da variável.

NOTA

O limite de caracteres do conteúdo variável é de 100 caracteres com espaços. Se você quiser adicionar textos, expressões, mídia, tabelas ou blocos de código mais longos, use Snippets. Para mais informações, leia o artigo sobre Snippet.

Opções de formatação

Use as seguintes opções de formatação de texto para estilizar o conteúdo da variável

um. Formatação básica de texto:
Negrito
Itálico
Tachado
Sublinhado
Tamanho da fonte (8 a 36)

b. Formatação adicional:

Clique no ícone Mais texto para acessar:
Família de fontes (escolha na lista de fontes)
Cor do texto (seletor de cores ou código HEX)
Cor de fundo (seletor de cores ou código HEX)
Subscrito
Sobrescrito
Formatação clara

c. Inserir link - Para adicionar um hiperlink.

  • Clique no ícone Inserir link .

  • Digite o URL e adicione texto ao link.

  • Se necessário, selecione Abrir em uma nova guia.

  • Clique em Inserir.

  1. Clique no botão Criar variável .

A variável recém-criada aparecerá na página Variáveis , onde poderá ser editada ou excluída conforme necessário.

To create new variables


Usando variável em uma página de artigo/categoria

Você pode adicionar uma variável à sua página de artigo/categoria usando dois métodos.

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 editor, poderá inserir variável usando a barra de ferramentas.

Método 2: Na barra de ferramentas (Markdown, WYSIWYG e WYSIWYG avançado)

  1. Clique no ícone Reutilização de conteúdo () para o editor Markdown e WYSIWYG.
    (ou)
    No editor WYSIWYG avançado, use o comando /variables de barra para acessar variáveis.

  2. 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.

  1. 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.

Inserting variables from the article editor.


Página Variáveis

Você pode exibir, editar ou excluir uma variável na página Variáveis .

  1. Navegue até Documentação () > Ferramentas de conteúdo > Reutilização de conteúdo > Variáveis no portal da base de dados de conhecimento.

    A página Variáveis é exibida, onde você pode encontrar a lista de variáveis que você já adicionou.

Overview page of variables

  1. Idiomas: Para filtrar as variáveis em Global ou em um idioma específico.

  2. Variável de pesquisa: pesquise a lista de variáveis com base no nome.

  3. Usado em: Se uma variável não for adicionada a nenhuma página de artigo/categoria, o status será -. Se uma variável for adicionada a qualquer página de artigo/categoria, você poderá clicar no botão Exibir para ver a lista de páginas de artigos/categoria que contêm a variável.

  4. Idioma: O idioma desejado de cada variável.

  5. Última modificação: a última vez que o conteúdo da variável foi atualizado.

  6. Visualização: Clique no nome da variável e você poderá visualizar o conteúdo da variável.

  7. Progresso: clique no ícone de globo para visualizar o progresso da variável em vários idiomas.

  8. Ícone Editar (): para editar o conteúdo da variável. Depois de fazer as alterações, clique em Atualizar.

  9. Ícone Excluir (): para remover a variável.


Exibir dependência de página de artigo/categoria

Na página Variáveis , você pode encontrar a coluna Usado em .

  1. 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.

  2. Clique no artigo para expandir a seção.

  3. 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 (Publicado, Rascunho, Novo Artigo).

    • As informações de hora/data em que a variável foi inserida na página de artigo/categoria.

    Image showing dependencies of a variable


Editando uma variável existente

  1. Navegue até Documentação () > Ferramentas de conteúdo > Reutilização de conteúdo > Variáveis no portal da base de dados de conhecimento.

    A página Variáveis é exibida. Você pode encontrar a lista de variáveis que você já adicionou.

  2. 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.

  • Estilo (): O estilo tem duas opções.

    • Verde: para alterar a cor do texto do link para verde.

    • Espessura: para aumentar a espessura do texto do 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.

  1. 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

  1. Navegue até Documentação () > Ferramentas de conteúdo > Reutilização de conteúdo > Variáveis no portal da base de dados de conhecimento.

    A página Variáveis é exibida. Você pode encontrar a lista de variáveis que você já adicionou.

  2. Passe o mouse sobre a variável desejada e clique no ícone Excluir ().

  3. Clique em Sim no prompt de 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.

to perform deletion of variables


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

  1. Navegue até as ferramentas Documentação () > Conteúdo > Reutilização de conteúdo > Variáveis no portal da base de dados de conhecimento.

  2. Clique em Criar variável.

  3. No menu suspenso Idioma , selecione o idioma pretendido (exceto global).

  4. Insira o nome da variável e o conteúdo da variável em inglês (ou no idioma padrão).

  5. Para traduzir o conteúdo para outros idiomas, clique no menu suspenso Traduzir para outros idiomas .

  6. 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.

  7. Quando as traduções estiverem concluídas, clique em Criar variável 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.

Translating new variables

Traduzindo variáveis existentes

NOTA

As variáveis globais não podem ser traduzidas.

  1. Clique na variável existente desejada que deseja traduzir.

  2. Navegue até Traduzir para outros idiomas e selecione o idioma desejado que a variável precisa traduzir.

  3. Clique em Traduzir.

  4. Se necessário, você pode navegar para outros idiomas e traduzi-los.

  5. Para retraduzir o conteúdo, clique em Traduzir novamente, o que substituirá a tradução existente pela nova.

  6. Se você precisar remover a variável traduzida para um idioma específico, clique em Remover idioma.

    Você pode retraduzir o conteúdo a qualquer momento, se necessário.

Translate existing variables


Perguntas frequentes

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.