O glossário no Document360 é uma única coleção de termos definidos para todo o projeto, que você cria uma vez e reutiliza em todos os artigos e páginas de categorias. Termos do glossário aparecem com um sublinhado pontilhado no seu conteúdo. Os leitores podem passar o mouse sobre qualquer termo para ver sua definição sem precisar se afastar da página.
Por exemplo, ao adicionar a sigla GDPR, você pode defini-la como "Regulamento Geral de Proteção de Dados", e o termo será usado consistentemente em todos os artigos relevantes. O Document360 suporta um glossário por projeto. Todos os termos são armazenados centralmente e disponíveis em todos os espaços de trabalho e idiomas daquele projeto.
Termos do glossário estão disponíveis tanto na base de conhecimento quanto no widget da base de conhecimento.
Por que adicionar um glossário à sua base de conhecimento
- Melhor legibilidade: Os termos do glossário permitem que os leitores obtenham definições instantâneas para termos complexos sem sair da página, reduzindo confusão e melhorando a compreensão.
- Consistência: Uma vez que um termo é adicionado ao glossário, ele pode ser reutilizado em vários artigos, garantindo que a terminologia seja definida de forma consistente em toda a sua base de conhecimento.
- Economizando tempo para escritores: Redatores técnicos não precisam mais definir termos em cada artigo individual, o que reduz a redundância e acelera a criação de conteúdo.
- Educação específica para produtos: Use o glossário para definir termos específicos do produto ou jargão do setor, ajudando os leitores a se familiarizarem com sua terminologia e aprimorando sua compreensão do seu produto.
Adicionar termos específicos do setor ao seu glossário também melhora o SEO da sua base de conhecimento. Termos do glossário aumentam a relevância da sua documentação nos resultados dos mecanismos de busca ao associar definições a palavras-chave.
A página do Glossário
Navegue até ferramentas de conteúdo () > recursos de conteúdo > Glossário para acessar e gerenciar seus termos do glossário.
| Elemento | Descrição |
|---|---|
| Use a IA do Eddy para geração de glossários | Usa o Eddy AI para escanear seu conteúdo e sugerir automaticamente termos de glossário para frases-chave e siglas. |
| Criar | Cria um novo termo glossário. |
| Glossário de importação | Importa múltiplos termos de glossário de um arquivo CSV. |
| Idiomas | Filtra o glossário por Global ou por uma linguagem específica. |
| Glossário de busca | Busca por um termo do glossário pelo nome. |
| CSV de exportação | Exporta termos selecionados do glossário como arquivo CSV para backup ou uso externo. |
| Prévia | Clique no nome de um termo do glossário para visualizar seu conteúdo. |
| Usado em | Mostra um traço se o termo não for usado. Se usado, clique em Visualizar para ver a lista de artigos e páginas de categoria onde ele é referenciado, junto com o espaço de trabalho, idioma, status do artigo, versão, detalhes do colaborador e data da última atualização. |
| Idioma | Mostra a língua atribuída a cada termo do glossário. |
| Última modificação | Mostra a data e hora em que o termo foi atualizado pela última vez. |
Comece com o glossário
Gerador de glossário de IA
Use o Eddy AI para escanear automaticamente o conteúdo da sua base de conhecimento e gerar sugestões de termos de glossário para frases-chave e siglas.
Saiba mais →Adicionar novos termos do glossário
Crie termos de glossário individualmente ou importe múltiplos termos ao mesmo tempo a partir de um arquivo CSV, com opções de formatação para definições.
Saiba mais →Gerenciar e traduzir termos do glossário
Edite, traduza, exclua e exporte termos do glossário para seu projeto e idiomas.
Saiba mais →Insira termo do glossário no artigo
Adicione termos de glossário aos seus artigos usando dois métodos no editor Markdown ou o comando barra no editor avançado WYSIWYG.
Saiba mais →Adicione o glossário ao seu site de base de conhecimento
Mostre o glossário aos leitores adicionando um link ao cabeçalho, rodapé ou navegação secundária do seu site.
Saiba mais →Melhores práticas
- Defina os termos com o nível certo de detalhe. Escreva definições para seus leitores menos técnicos. Se um termo for óbvio para seu público, ele não precisa de uma entrada no glossário. Se isso puder confundir até mesmo um leitor, adicione.
- Use o campo Nome como um identificador estável. Mantenha o campo Nome minúsculo e sem espaços, por exemplo
api_keyougdpr. Isso permanece consistente entre os idiomas mesmo quando o texto visível do Term muda conforme a localidade. - Defina o escopo global para termos que não são traduzidos. Use Global para termos como nomes de produtos ou siglas que sejam iguais em todos os idiomas. Use um escopo de linguagem específico apenas quando o termo em si difere conforme a localidade.
- Verifique o uso antes de apagar. Deletar um termo do glossário remove a dica de todos os artigos onde foi usada. Use a Visualização na coluna Usado em para verificar o impacto antes de excluir um termo amplamente utilizado.
- Use o Eddy AI para criar seu glossário. Para um projeto novo ou grande, use o gerador de glossários de IA para obter um conjunto inicial de sugestões com base no seu conteúdo existente, depois revise e refine cada uma antes de publicar.
FAQ
O que acontece se eu excluir um termo do glossário?
Quando um termo do glossário é excluído, ele é removido de todos os artigos onde foi usado. O termo não exibirá mais sua definição como uma dica para leitores.
Posso importar vários termos do glossário ao mesmo tempo?
Sim. Use a opção Importar glossário na página do Glossário para importar termos em massa de um arquivo CSV. Isso é útil para projetos grandes onde múltiplos termos precisam ser adicionados rapidamente.
Os termos do glossário podem ser filtrados por idioma?
Sim. Use o menu suspenso Idiomas na página do Glossário para filtrar termos por idioma. Termos marcados como Global estão disponíveis em todos os idiomas da sua base de conhecimento.
O glossário muda quando eu troco entre os espaços de trabalho?
Não. O glossário é configurado no nível do projeto, não no nível do espaço de trabalho. Todos os termos são armazenados em um único glossário de projeto e aparecem em todo o site da base de conhecimento. Alternar entre espaços de trabalho não altera o glossário nem qualquer outra configuração de ferramentas de conteúdo.
Como adiciono um termo de glossário aos meus artigos?
Navegue até ferramentas de conteúdo () > Recursos de conteúdo > Glossário e crie um novo termo. Uma vez adicionado, o termo pode ser inserido nos seus artigos e os leitores podem passar o mouse sobre ele para ver a definição.