Trechos no Document360 são criados e gerenciados a partir da página de Trechos em Ferramentas de Conteúdo. A partir desta página, você pode criar novos trechos, escolher seu editor, usar o Eddy AI para refinar o conteúdo, verificar onde os trechos são usados em toda a sua base de conhecimento e editá-los ou excluí-los individualmente ou em massa.
A página de Snippets
- Navegue para ferramentas de conteúdo () na barra de navegação da esquerda.
- Selecione Recursos de Conteúdo > Trechos no painel de navegação esquerdo.
| Elemento | Descrição |
|---|---|
| Criar | Cria um novo trecho. |
| Detecção de conteúdo duplicado | Identifica textos duplicados na sua documentação e sugere convertê-lo em trechos. |
| Idiomas | Filtra a lista de trechos por Global ou por uma linguagem específica. |
| Trechos de busca | Busca por trechos por nome. |
| Caixa de seleção | Seleciona um ou mais trechos para exclusão em massa. |
| Nome | Clique no nome de um trecho para pré-visualizar seu conteúdo. |
| Usado em | Mostra onde o trecho é usado. Exibe um traço se não for utilizado. Se usado, clique em Visualizar para ver os artigos ou páginas de categoria onde foi inserido. Artigos arquivados e páginas de categorias não são contados. |
| Idioma | Indica a linguagem atribuída ao trecho. |
| Última modificação | Mostra a data e hora em que o trecho foi atualizado pela última vez. |
| Status da tradução | Clique no ícone do globo para verificar o progresso da tradução. Um check verde significa que o trecho foi traduzido para aquele idioma. Um X significa que não foi. |
| Edit | Abre o trecho para edição. |
| Excluir | Apaga o trecho. Para exclusão em massa, selecione as caixas de seleção e clique em Excluir no topo. |
Detecção de conteúdo duplicado
O banner de detecção de conteúdo duplicado no topo da página de Snippets ajuda você a identificar e gerenciar texto repetido em toda a sua documentação. Esse recurso é alimentado pelo Eddy AI. Ele escaneia seu projeto em busca de parágrafos que aparecem várias vezes entre artigos, gera um relatório mostrando onde existe conteúdo duplicado e sugere convertê-lo em trechos reutilizáveis.
- Clique em Encontrar duplicatas no banner para começar a escanear seu projeto.
- Após a varredura ser concluída, o número total de blocos de texto duplicados detectados é exibido.
- Se uma varredura já foi realizada, clique em Escanear novamente para reiniciar o processo.
- Clique em Revisar sugestões para abrir o relatório de Detecção de Conteúdo Duplicado e revisar as descobertas.
Para mais informações, leia Detecção de Conteúdo Duplicado →
Crie um trecho
- Na página de Snippets , clique em Criar no canto superior direito.
- No diálogo Criar novo trecho , configure o seguinte:
- Nome: Insira um nome de até 50 caracteres. Você pode usar letras, números, hífens e sublinhas.
- Idioma: Selecione um idioma. O padrão é Global.
- Editor: Expanda Avançado e escolha Markdown ou Advanced WYSIWYG. O padrão é baseado nas configurações do seu projeto.
- Clique em Criar.
- Insira seu conteúdo no editor.
Editor de markdown: Use as ferramentas de formatação para formatar seu texto.
Editor WYSIWYG avançado: Use a barra de ferramentas ou o menu de inserção rápida para formatar seu conteúdo.
Depois de selecionar o editor WYSIWYG Avançado, não pode voltar para o Markdown. Se começar com o Markdown, pode converter para WYSIWYG Avançado para fins de tradução, já que o Markdown não suporta Translate com Eddy AI. Você não pode voltar para o Markdown após a conversão.
- Para mudar o idioma do trecho, use o menu suspenso de linguagem no topo do editor.
- Clique em Salvar ou pressione
Ctrl + S.
Você também pode usar HTML personalizado na visualização de Código para formatação. Tags não suportadas serão sanitizadas automaticamente.
Use a IA do Eddy em conteúdo de trechos
Ao rascunhar um trecho no editor Advanced WYSIWYG, passe o mouse sobre qualquer conteúdo e use o Eddy AI para deixar o texto mais longo ou mais curto, melhorá-lo, alterar o tom, converter fala, mudar a voz, dividir frases ou gerar elementos como tabelas, gráficos de pizza e fluxogramas.
Visualizar uso de trechos
Antes de editar ou deletar um trecho, você pode verificar exatamente quais artigos e páginas de categoria o utilizam.
- Na página Snippets , localize o trecho na coluna Usado em .
- Clique em Visualizar. O painel Visualizar referências se abre. Para cada referência, você pode ver a versão do artigo, o espaço de trabalho do projeto e o idioma, o nome do usuário que adicionou o trecho, o estado do artigo (Rascunho ou Publicado) e a data e hora em que o trecho foi inserido.
- Clique no ícone para abrir a versão do artigo em uma nova aba.
Artigos e páginas de categorias arquivados não são listados no painel Visualizar referências e não são contados na coluna Usado em . Um trecho usado apenas em conteúdo arquivado mostra um traço, como se não fosse utilizado. As referências são preservadas e reaparecem quando o conteúdo é desarquivado.
Editando um trecho
- Na página de Snippets , passe o mouse sobre o trecho e clique no ícone Editar ().
- Atualize o conteúdo conforme necessário.
- Clique em Atualizar.
Quando você atualiza um trecho, as mudanças são automaticamente refletidas em todos os artigos e páginas de categoria onde ele é utilizado, incluindo os publicados, sem a necessidade de republicá-los.
Exclua um trecho
- Na página de Snippets , passe o mouse sobre o trecho e clique no ícone Delete ().
- Clique em Sim , no diálogo de confirmação.
Para excluir em massa, selecione as caixas de seleção ao lado dos trechos que deseja excluir e clique em Excluir no topo da lista.
Quando você exclui um trecho, ele é removido de todos os artigos onde ele é referenciado. O artigo mantém sua versão atual. No site da base de conhecimento, o conteúdo ao redor se ajusta automaticamente e não resta espaço vazio. No portal, um símbolo de carregamento aparece no bloco de conteúdo onde o trecho foi removido. Selecione esse bloco para inserir outro trecho ou delete-o manualmente.
Considerações
| Item | Detalhes |
|---|---|
| Comprimento do nome do trecho | No máximo 50 caracteres. |
| Caracteres do nome do trecho | Apenas letras, números, hífens e sublinhas. |
| Nome do trecho | Não pode ser alterado após a criação. |
| Tipo de editor | Uma vez mudado para Advanced WYSIWYG, não pode ser revertido para Markdown. |
| Trechos globais | Não pode ser traduzido. |
| Contagem de trechos por projeto | Até 200 fragmentos. |
| Variáveis dentro de trechos | Não suportado. Variáveis não renderizam corretamente na visualização do editor ou nas exportações do PDF. |
| Conteúdo arquivado | Artigos arquivados e páginas de categorias são excluídos da coluna Usado em e do painel Visualizar referências. |
Melhores práticas
- Escolha seu editor com cuidado na criação. Mudar do Markdown para o Advanced WYSIWYG é possível, mas irreversível. Use o Advanced WYSIWYG se planeja traduzir o trecho ou usar formatação rica.
- Trechos de nomes de forma descritiva. Use nomes que identifiquem o tipo e o propósito do conteúdo, por exemplo
Support_Contact_BlockouAPI_Disclaimer. Isso facilita encontrar e inserir trechos sem ter que pré-visualizar cada um. - Use o escopo Global por padrão. Defina a linguagem como Global , a menos que o conteúdo do trecho realmente diferia de idioma para idioma. Trechos específicos de cada idioma exigem gerenciamento separado por idioma.
- Verifique dependências antes de excluir. Use Visualizar na coluna Usado em para confirmar o impacto entre os artigos antes de excluir um trecho que possa ser amplamente utilizado. Conteúdo arquivado não está listado, então verifique também a página de Arquivo se você tiver artigos ou categorias arquivadas.
- Prefira trechos a copiar e colar. Se o mesmo bloco de conteúdo aparecer em mais de dois artigos, crie um trecho em vez de duplicá-lo manualmente.