Gerenciando Versões de Documentos
Como criar, editar, publicar e gerenciar versões de documentos legais
Guia: Gerenciando Versões de Documentos
Visão Geral
O Termatica utiliza um sistema de versionamento para documentos legais. Cada documento pode ter múltiplas versões, permitindo atualizar conteúdo enquanto mantém histórico completo de alterações.
---
Conceitos de Versionamento
Por que Versionar?
- Compliance: Mantenha histórico de todas as versões para auditoria - Rastreabilidade: Saiba exatamente qual versão cada usuário aceitou - Transição Suave: Defina datas de vigência futuras - Comparação: Visualize diferenças entre versões
Estados de uma Versão
| Estado | Descrição | Visível para Usuários? | |--------|-----------|------------------------| | Rascunho | Em edição, não publicada | Não | | Publicada | Conteúdo finalizado | Sim (se ativa) | | Ativa | Versão corrente em vigor | Sim | | Inativa | Versão antiga/arquivada | Não |
Ciclo de Vida
`
Rascunho → Publicar → Ativa → [Nova Versão] → Inativa
`
---
Criando uma Nova Versão
Via Dashboard
1. Acesse Documentos > Selecione o documento 2. Clique em Versões > Nova Versão 3. Preencha os campos:
| Campo | Descrição | Exemplo |
|-------|-----------|---------|
| Versão | Número da versão | 1.0, 2.0, 2.1 |
| Título | Título completo | "Termos de Uso - Versão 2.0" |
| Resumo das Alterações | O que mudou | "Atualização da cláusula de privacidade" |
| Data de Vigência | Quando entra em vigor | 2024-02-01 |
| Idioma | Idioma do conteúdo | Português (Brasil) |
4. Clique em Salvar como Rascunho
Criando a Partir de Versão Anterior
Para atualizar um documento existente:
1. Na versão atual, clique em Criar Nova Versão 2. O sistema copia o conteúdo da versão anterior 3. Edite apenas o que mudou 4. Atualize o número da versão
---
Editando o Conteúdo
Editor de Conteúdo
O Termatica suporta dois formatos:
#### Markdown (Recomendado)
`markdown
Termos de Uso
1. Aceitação dos Termos
Ao utilizar nossos serviços, você concorda com estes termos.
1.1 Definições
- Usuário: Pessoa que utiliza a plataforma - Serviço: Funcionalidades oferecidas
2. Uso Permitido
O usuário concorda em:
1. Fornecer informações verdadeiras
2. Não violar direitos de terceiros
3. Respeitar as políticas da plataforma
`
#### HTML
`html
<h1>Termos de Uso</h1>
<h2>1. Aceitação dos Termos</h2> <p>Ao utilizar nossos serviços, você concorda com estes termos.</p>
<h3>1.1 Definições</h3>
<ul>
<li><strong>Usuário</strong>: Pessoa que utiliza a plataforma</li>
<li><strong>Serviço</strong>: Funcionalidades oferecidas</li>
</ul>
`
Dicas de Formatação
| Elemento | Markdown | Resultado |
|----------|----------|-----------|
| Título H1 | # Título | Título principal |
| Título H2 | ## Seção | Seção |
| Título H3 | ### Subseção | Subseção |
| Negrito | texto | texto |
| Itálico | texto | texto |
| Lista | - item | Lista com marcadores |
| Lista numerada | 1. item | Lista numerada |
| Link | texto | Link clicável |
---
Publicando uma Versão
Requisitos para Publicação
Antes de publicar, verifique:
- [ ] Conteúdo revisado e aprovado - [ ] Número da versão definido - [ ] Data de vigência configurada - [ ] Documento pai está ativo
Processo de Publicação
1. Na versão em rascunho, clique em Publicar 2. Confirme a publicação 3. A versão muda para status Publicada
Data de Vigência
A data de vigência determina quando a versão entra em vigor:
| Cenário | Data de Vigência | Comportamento | |---------|------------------|---------------| | Imediato | Hoje ou passado | Entra em vigor imediatamente | | Agendado | Data futura | Entra em vigor na data definida | | Sem data | Vazio | Entra em vigor imediatamente |
---
Ativando e Desativando Versões
Múltiplas Versões Ativas
É possível ter múltiplas versões ativas simultaneamente:
- Versão vigente: Data de vigência já passou - Versão agendada: Data de vigência futura
O sistema automaticamente considera a versão mais recente como "atual".
Desativando uma Versão
Para arquivar uma versão antiga:
1. Na versão, clique em Desativar 2. A versão permanece no histórico mas não é exibida
Nota: Aceites já registrados permanecem vinculados à versão desativada.
---
Histórico de Alterações
Visualizando o Histórico
Cada versão mantém registro de:
- Data e hora de criação - Usuário que criou - Alterações realizadas (se houver log) - Data de publicação - Número de aceites
Comparando Versões
Para visualizar diferenças entre versões:
1. Acesse a versão desejada 2. Clique em Histórico 3. Selecione duas versões para comparar 4. O sistema exibe as diferenças (diff)
---
Traduções
Documentos Multilíngue
O Termatica suporta múltiplos idiomas por versão:
1. Na versão, clique em Traduções 2. Selecione o idioma desejado 3. Opções: - Traduzir Manualmente: Edite o conteúdo - Tradução Automática: Usa IA (requer OpenAI API Key)
Idiomas Disponíveis
| Código | Idioma |
|--------|--------|
| pt-br | Português (Brasil) |
| pt | Português (Portugal) |
| en | English |
| es | Español |
| fr | Français |
| de | Deutsch |
| it | Italiano |
Tradução Automática com IA
Requisitos:
- Chave API da OpenAI configurada
- Modelo recomendado: gpt-4o-mini
Processo: 1. Clique em Tradução Automática 2. Selecione idioma de destino 3. Aguarde a tradução 4. Revise e ajuste o resultado 5. Publique a tradução
---
Notificações de Nova Versão
Notificando Usuários
Quando uma nova versão é publicada, você pode notificar:
1. Na versão, clique em Notificações 2. Selecione os destinatários: - Todos que aceitaram versão anterior - Usuários específicos - Lista de emails 3. Personalize a mensagem 4. Envie as notificações
Template de Notificação
`
Assunto: Atualização dos Termos de Uso
Olá {nome},
Atualizamos nossos Termos de Uso. Versão anterior: {versao_anterior} Nova versão: {nova_versao}
Principais alterações: - {resumo_alteracoes}
Acesse e revise: {link_aceite}
Atenciosamente,
Equipe {empresa}
`
---
Boas Práticas
Numeração de Versões
Sugerimos o padrão Semantic Versioning:
| Tipo de Alteração | Versão | Exemplo | |-------------------|--------|---------| | Correções menores | Patch | 1.0 → 1.0.1 | | Novas cláusulas | Minor | 1.0 → 1.1 | | Reescrita completa | Major | 1.0 → 2.0 |
Resumo de Alterações
Sempre documente o que mudou:
`
✓ Bom:
"Atualização da cláusula 5.2 sobre tratamento de dados pessoais
conforme LGPD. Adição da seção 8 sobre cookies."
✗ Ruim:
"Atualizações diversas"
`
Período de Transição
Para alterações significativas:
1. Publique a nova versão com data futura (ex: 30 dias) 2. Notifique usuários sobre a mudança 3. Permita revisão antes da vigência 4. Após a data, a nova versão entra em vigor
---
Solução de Problemas
Não consigo publicar a versão
Verifique: - [ ] Documento pai está Ativo - [ ] Conteúdo não está vazio - [ ] Número da versão está preenchido
Usuários ainda veem versão antiga
Verifique: - [ ] Nova versão está Publicada - [ ] Nova versão está Ativa - [ ] Data de vigência já passou - [ ] Cache do navegador foi limpo
Aceites não aparecem na nova versão
Isso é esperado. Aceites ficam vinculados à versão específica que foi aceita. Para nova versão, usuários precisam aceitar novamente.
---
Próximos Passos
- Incorporação e Embedding - Incorpore documentos em sites externos - Integração via API - Automatize com a API REST - Leitura Pública - Exiba documentos sem aceite