Exportando documentação
A documentação só é útil quando chega às pessoas que precisam dela. Exporte a documentação do seu processo sempre que necessário, no formato mais adequado ao público: Word para ciclos de revisão, Markdown para controle de versão, PDF ou impressão para reuniões e arquivamento. A exportação pode ser feita a qualquer momento; não é necessário publicar, e cada exportação reflete o estado atual do processo, incluindo a Matriz RACI e quaisquer artefatos anexados.
Formatos de exportação compatíveis
| Formato | Use para |
|---|---|
| Documentos renderizados no servidor para distribuição, revisão ou arquivamento | |
| Word (.docx) | Documentos editáveis para edição posterior, distribuição ou uso no seu sistema de gestão da qualidade |
| Markdown | Documentos em texto simples para controle de versão e fluxos de trabalho de desenvolvedores |
| Impressão | Cópias rápidas em papel ou arquivos PDF gerados pela caixa de diálogo de impressão do navegador |
Escolhendo o que exportar
O menu de exportação inclui Configurações de exportação, onde você define o que o documento exportado deve conter:
- Incluir elementos sem documentação: também lista elementos do modelo que ainda não têm descrição, deixando as lacunas visíveis.
- Incluir gráficos: adiciona os gráficos do processo ao documento.
- Incluir RACI de cada atividade: mostra a atribuição RACI por atividade, além da matriz.
Use Definir como padrão para aplicar essas escolhas a todos os modelos do ambiente, ou Salvar para este modelo quando apenas o processo atual deve ser diferente.
Exemplo de exportação para Word
A exportação para Word mantém a estrutura da sua árvore de documentação: cada seção se torna um título, a Matriz RACI é renderizada como uma tabela e os artefatos anexados são listados com seus links.
Exemplo de exportação para Markdown
A exportação para Markdown é um texto simples com títulos e tabelas padrão, por isso se integra naturalmente a repositórios Git, wikis e pipelines de documentação.
Exemplo de exportação para impressão
Use a caixa de diálogo de impressão do navegador para exportar a documentação como PDF ou cópia em papel, ou use Baixar como PDF para gerar um PDF renderizado no servidor sem abrir a caixa de diálogo de impressão. O layout de impressão é otimizado para leitura, permitindo compartilhar um documento organizado com as partes interessadas que preferem papel.