Um trecho é um bloco reutilizável de conteúdo: texto, parágrafos, tabelas, imagens, referências, blocos de código ou qualquer combinação que você crie uma vez e insera em vários artigos. Quando você atualiza um trecho, a mudança é automaticamente refletida em todos os artigos que o utilizam. Trechos são armazenados em uma biblioteca central dentro do Document360 e são invisíveis como um elemento separado para os leitores. No site da base de conhecimento, o conteúdo de trecho é apresentado como conteúdo comum de artigo.
Por que usar trechos
Trechos resolvem um problema comum de documentação: conteúdo que aparece em múltiplos artigos precisa ser mantido em vários lugares. Sem trechos, atualizar um aviso de produto, um bloco de contato de suporte ou um aviso compartilhado significa encontrar cada artigo que o contém e editar cada um individualmente. Uma instância perdida leva a informações inconsistentes.
Com trechos, esse conteúdo está em um só lugar:
- Única fonte de verdade. Uma edição, atualizações constantes por toda parte.
- Redução da manutenção de custos. Nada de buscar conteúdo repetido entre artigos.
- Consistência em escala. O mesmo aviso, nota ou passo aparece de forma idêntica em todos os artigos.
- Autoria mais rápida. Os escritores inserem blocos pré-definidos em vez de redigitar ou copiar e colar.
Trechos vs. variáveis
O Document360 oferece duas ferramentas de reutilização de conteúdo. Escolher o certo depende do que você está reutilizando.
| Trechos | Variáveis | |
|---|---|---|
| Tipo de conteúdo | Blocos formatados como parágrafos, tabelas, imagens, callouts e código. | Valores de texto simples, como nomes, números, URLs e frases curtas. |
| Uso típico | Avisos, passos compartilhados, bloqueios de contato, avisos repetidos. | Nomes dos produtos, números de versão, endereços de e-mail de suporte. |
| Limite de caracteres | Sem limite de caracteres. | 300 caracteres. |
| Pode conter formatação? | Sim, formatação completa do editor. | Não, só por mensagem. |
| Pode fazer ninho em outros fragmentos? | Sim, apenas trechos do Markdown. | Não. |
| Inserido via | Sintaxe de código de barra de ferramentas ou mescagem. | Barra de ferramentas, sintaxe de mesclar código ou comando de barra. |
Comece com Snippets
Crie e gerencie trechos
Crie um trecho, escolha seu editor, use a IA do Eddy durante o rascunho e gerencie trechos da página de Snippets — edite, delete, exclua em massa e visualize dependências.
Saiba mais →Uso e tradução de trechos
Insira trechos em artigos usando três métodos, traduza trechos para bases de conhecimento multilíngues e resolva problemas comuns.
Saiba mais →Melhores práticas
- Use trechos para conteúdos que aparecem em três ou mais artigos. Se o mesmo bloco aparecer em apenas um ou dois lugares, editar esses blocos diretamente é mais simples do que criar e gerenciar um trecho.
- Mantenha cada trecho focado em um único propósito. Um trecho que cumpre uma função única e específica, como um aviso, um bloco de contato ou um aviso compartilhado, é mais fácil de reutilizar e atualizar do que um que agrupa conteúdo não relacionado.
- Dê um nome descritivo de trechos. Use um padrão de nomenclatura que reflita o tipo e propósito do conteúdo, por exemplo
[Warning] Unsaved changesou[Contact] Support block. Nomes consistentes facilitam a digitalização da biblioteca e reduzem a chance de inserir o trecho errado. - Verifique as dependências antes de editar ou deletar. Alterações em um trecho se aplicam imediatamente a todos os artigos que o utilizam, incluindo os publicados. Use a coluna Usado em para revisar o impacto antes de fazer alterações.
- Não use variáveis dentro dos trechos. Variáveis dentro de snippets não são renderizadas corretamente na prévia do editor ou nas exportações do PDF. Gerencie valores dinâmicos separadamente do conteúdo dos trechos.
- Traduza trechos junto com artigos. Se sua base de conhecimento suporta múltiplos idiomas, traduza trechos ao mesmo tempo que os artigos que os utilizam. Um trecho sem tradução mostrará o valor padrão do idioma para leitores em outros locais.