Criar modelo

Modelos de artigos no Document360 são estruturas pré-desenhadas que você e sua equipe podem reutilizar ao criar novos artigos. Em vez de construir o mesmo layout do zero toda vez, os templates fornecem uma estrutura consistente, títulos, seções e conteúdo provisório que os escritores podem preencher diretamente.

Os modelos estão disponíveis para todos os membros da equipe do projeto e podem ser criados do zero, construídos a partir de um artigo existente ou clonados a partir de um modelo do sistema. Todos os templates são gerenciados a partir da página de Templates em Recursos de Conteúdo.

O Document360 fornece dois tipos de modelos:

• Modelos de sistema — Modelos pré-construídos criados automaticamente com base na seleção do seu caso de uso de integração. Esses podem ser editados e clonados, mas não podem ser excluídos.
• Modelos personalizados — Modelos criados pela sua equipe. Esses podem ser editados, clonados e excluídos.

Casos de uso

• Artigos de solução de problemas — Crie um modelo com seções padrão como Sintomas, Causa e Resolução. Os redatores preenchem o conteúdo de cada nova edição sem reconstruir a estrutura a cada vez.
• Notas de lançamento — Use um modelo com seções pré-definidas para Novos recursos, Melhorias e correções de bugs para garantir que cada nota de lançamento siga o mesmo formato.
• Guias práticos — Construa um modelo com uma visão geral, pré-requisitos, instruções passo a passo e seções de artigos relacionados para uma documentação prática consistente em toda a base de conhecimento.
• Páginas de referência da API — Crie um modelo com seções para Endpoint, Parâmetros, Exemplo de Solicitação e Exemplo de Resposta para padronizar a documentação do desenvolvedor.
• Integração de novos escritores — Compartilhe modelos com novos membros da equipe para que possam começar a escrever imediatamente, sem precisar de orientação sobre estrutura de artigos ou convenções de formatação.

Maneiras de criar um modelo

Existem duas maneiras de criar um modelo no Document360:

Ambas as abordagens resultam em um modelo reutilizável disponível para todos os usuários do projeto.

Criar um novo modelo

1. Na barra de navegação da esquerda, passe o mouse sobre as ferramentas de Conteúdo e selecione Templates. A página Gerenciar modelos vai aparecer.
2. Clique em Criar modelo no canto superior direito. O painel Criar modelo vai aparecer.
3. Insira um nome no campo Nome do Modelo .
4. Selecione o tipo de editor — Advanced WYSIWYG ou Markdown.
5. Insira uma descrição opcional. O limite de caracteres é de 250 caracteres, incluindo espaços.
6. Clique em Criar. O modelo abre no editor.

7. Adicione e formate o conteúdo do seu modelo — títulos, texto provisório, indicações, tabelas ou quaisquer outros elementos relevantes para o tipo de artigo.
8. Clique em Salvar ou Salvar e fechar no menu suspenso de Salvar quando terminar.

O modelo é adicionado à página Gerenciar modelos e está imediatamente disponível para todos os usuários ao criar artigos.

Para criar um artigo usando um modelo, veja Criar artigo a partir do modelo.

Salve um artigo existente como modelo

Qualquer artigo, independentemente de seu status atual (Publicado, Rascunho, Revisão ou Oculto), pode ser salvo como um modelo reutilizável.

1. Abra o artigo no editor.
2. Clique no ícone Mais (⋯) no cabeçalho do artigo.
3. Selecione Salvar como modelo e clique em Salvar no diálogo Salvar como modelo .

O artigo é salvo como um modelo e está imediatamente disponível na biblioteca de modelos. Navegue até a página Gerenciar modelos nas ferramentas de conteúdo para visualizar, editar ou excluir.

Gerenciamento de modelos

Depois que os modelos forem criados, você pode editá-los, cloná-los ou excluí-los da página Gerenciar modelos . Navegue até ferramentas de conteúdo > recursos de conteúdo > Modelos para acessar todos os modelos do seu projeto.

Editar um modelo

1. Na página Gerenciar modelos , passe o mouse sobre o modelo que você deseja editar e clique no ícone Editar .
2. O modelo abre no editor. Para atualizar o nome ou descrição do modelo, clique no ícone Editar ao lado do nome do modelo no topo.
3. Faça as alterações necessárias nos campos de nome, descrição ou conteúdo.
4. Clique em Salvar.

Clone um modelo

Clonar cria uma cópia de um template existente que você pode modificar sem afetar o original. Isso é útil quando você quer criar uma variação de um template existente.

1. Na página Gerenciar modelos , passe o mouse sobre o modelo que você quer clonar.
2. Clique no ícone Clone . Um modelo duplicado é criado imediatamente com o mesmo conteúdo e configurações.

Exclua um modelo

1. Na página Gerenciar modelos , passe o mouse sobre o modelo que você deseja delettar.
2. Clique no ícone Excluir e confirme a exclusão no prompt.

Melhores práticas

• Crie modelos para cada tipo de artigo recorrente. Se sua equipe escrever o mesmo tipo de artigo mais de uma vez, um modelo economiza tempo e garante consistência.
• Use texto provisório em modelos para orientar os escritores — por exemplo, "Descreva o problema que o leitor está enfrentando" na seção Erros de um guia de solução de problemas. Isso reduz a ambiguidade e acelera a escrita.
• Defina o tipo do editor com cuidado. O tipo de editor não pode ser alterado após a criação de um modelo. Escolha Advanced WYSIWYG para conteúdo rico e Markdown para artigos com muito código ou texto.
• Guarde artigos polidos como modelos. Quando um artigo bem escrito segue uma estrutura que vale a pena repetir, salve-o como modelo diretamente do editor, em vez de recriá-lo do zero.
• Clone modelos de sistema como ponto de partida. Em vez de construir templates personalizados a partir de um branco, clone um template de sistema e modifique-o — isso é mais rápido e oferece uma estrutura base validada.
• Mantenha as descrições dos modelos claras e específicas. Uma boa descrição informa os escritores quando usar o modelo e para que tipo de artigo ele é — especialmente importante quando a biblioteca de modelos cresce.