Templates de documentação
Todo documento gerado segue um Template de documento. No aplicativo, eles são chamados de Templates de documento. O Template define quais partes compõem o documento e em que ordem: página de título, sumário, capítulos e seções, blocos de texto, campos de documentação, modelo, matriz RACI, documentação dos elementos, gráficos e atribuições de RACI por atividade.
Cada nível de arquitetura tem seus próprios Templates. Assim, uma visão geral breve do processo, um POP detalhado e um pacote para auditoria podem descrever o mesmo processo de maneiras diferentes.
Onde encontrar os Templates
- Configurações → Arquitetura de processos mostra cada nível em um cartão. Abra o selo Templates de documento do nível ou clique no ícone de edição para abrir o editor.
- Na aba Documentação, o seletor Template de documento na barra lateral alterna entre os documentos disponíveis. O Template padrão do nível é usado até alguém selecionar outro.
- Quem edita pode abrir o Template diretamente pela documentação: abra o menu de exportação e selecione Editar Template….
Os Templates são configurados em Arquitetura de processos. Todas as pessoas que podem consultar a documentação de um processo veem o documento gerado pelo Template. Cada exportação usa o Template selecionado na página de documentação.
Escolher e gerenciar Templates
O editor é uma única janela: o seletor de Templates e o botão de adição ficam na parte superior, a árvore do documento à esquerda e as configurações do item selecionado à direita. No rodapé ficam Cancelar e Salvar.
O editor abre no último Template que você editou para aquele nível. A opção Editar Template… na página de documentação abre o Template usado pelo documento atual.
- O seletor de modelos de documento na parte superior alterna entre os modelos do nível. Os itens marcados como Rascunho não ficam visíveis para quem tem acesso de visualização; Padrão indica o modelo que a página de documentação abre por padrão.
- + adiciona um modelo chamado Novo modelo de documento e o seleciona.
- Nome renomeia o modelo selecionado.
- Publicado define se quem tem acesso de visualização pode selecionar o modelo na página de documentação. Quem edita sempre vê os rascunhos.
- Definir como padrão define o modelo selecionado como aquele que a página de documentação usa quando nenhum outro é escolhido. Cada nível tem um único modelo padrão.
- Excluir modelo de documento remove o modelo selecionado. Não é possível excluir o único modelo padrão de um nível. Primeiro, defina outro modelo como padrão.
- Incluir elementos sem documentação adiciona à seção de elementos do documento os elementos do modelo que ainda não têm descrição. Desative essa opção quando o documento deve listar apenas a documentação concluída.
Adicionar ou excluir um Template e definir o padrão têm efeito imediato. O nome, a visibilidade, a opção de incluir conteúdo, a página de título e a árvore do documento são salvos ao clicar em Salvar.
Montar o documento
A árvore do documento fica à esquerda do editor. Arraste um item para reordená-lo ou solte-o em um capítulo ou seção para aninhá-lo. Use o menu da linha ou clique com o botão direito nela para adicionar ou remover conteúdo.
Capítulos e seções
- Adicionar capítulo abaixo insere um capítulo na raiz do documento.
- Adicionar seção ou Adicionar seção abaixo insere uma seção aninhada ou no mesmo nível.
- Selecione um capítulo ou uma seção para editar o Título e ativar ou desativar a opção Numeração automática. A numeração acompanha a árvore: capítulos usam X, suas seções usam X.Y e as seções mais profundas usam X.Y.Z. O painel mostra o nível de título do item.
- Excluir remove o item selecionado e seus filhos.
Itens de conteúdo
O menu de itens oferece:
- Adicionar texto / Adicionar texto abaixo insere um bloco Markdown. Escreva títulos, listas, links ou observações no campo Texto Markdown. Você também pode usar campos dinâmicos.
- Adicionar campo de documentação… / Adicionar campo de documentação abaixo… insere um dos campos de documentação publicados para o nível. Se um campo deixar de ser publicado, ele será removido do documento, que não exibirá conteúdo que o nível não publica mais.
- Adicionar modelo / Adicionar modelo abaixo exibe o diagrama do processo. Mostrar dados adiciona o resumo “Filtros e dados usados” abaixo do diagrama.
- Adicionar RACI / Adicionar RACI abaixo exibe a matriz RACI.
- Adicionar elementos / Adicionar elementos abaixo exibe a documentação de todos os elementos do modelo.
- Adicionar seção de gráficos insere a documentação dos gráficos nessa posição do documento. Você pode colocá-la na raiz ou dentro de qualquer capítulo ou seção.
- Adicionar RACI por atividade inclui a atribuição de RACI de cada atividade na seção de elementos. Se inserido na raiz, vale para o documento inteiro.
Adicionar página de título e Adicionar sumário só aparecem na raiz e podem ser inseridos uma vez cada. Ambos são itens: selecione um para editá-lo ou exclua-o se o documento não deve ter página de título ou sumário.
A página de título
Selecione o item da página de título para definir:
- Carregar imagem, Substituir ou usar o ícone de remoção para alterar a imagem de fundo.
- Título, que por padrão usa o nome do processo. Use variáveis para que o título acompanhe o processo.
- Subtítulo para indicar versão, classificação ou público.
Campos dinâmicos
O texto editável aceita campos dinâmicos que o ProcessMind preenche ao gerar o documento:
{{processName}}, {{processCode}}, {{processClassification}}, {{processOwner}}, {{processShortDescription}}, {{processStatus}}, {{version}}, {{author}}, {{publishedDate}}, {{currentDate}}
Clique em um marcador de campo dinâmico para copiá-lo ou clique duas vezes para inseri-lo no texto em edição. Se o campo não tiver valor para um processo, ele será exibido como texto vazio.
Templates e exportações
O Template define o documento. As exportações para PDF, Word e Markdown, assim como a impressão, seguem o Template selecionado. O que não estiver no Template não aparecerá na exportação. Para ocultar uma parte em um Template, exclua o item correspondente. Para manter diferentes estilos de documento em um nível de processo, crie um Template para cada estilo e defina como padrão aquele que deve abrir na página de documentação.
Tópicos relacionados
Melhore seus processos. Crie uma arquitetura conectada. Mantenha o controle.
Acesse na hora, sem cartão de crédito nem espera. Transforme a forma como sua organização trabalha em modelos de processo claros e conectados.
Crie sua arquitetura de processos, defina responsabilidades e controles e alinhe papéis e atribuições em todos os níveis.
Comece o teste grátis e crie uma base confiável para governar, gerenciar e melhorar seus processos continuamente.