Classes de Documentos e Governança
Introdução
Alguns documentos não podem simplesmente "ser editados e salvos". Um procedimento operacional, um contrato, um desenho de engenharia, um laudo regulatório — esses passam por estados pré-estabelecidos para aprovação, os usuários do projeto têm papéis definidos (quem redige, quem revisa, quem aprova) e exigem rastro de quem fez o quê e quando. Além disso, muitas vezes um documento em elaboração não pode ser visto por quem só deveria tomar conhecimento dele depois de aprovado.
As Classes de Documentos são a camada de governança formal do Sutram. Elas transformam uma categoria de registros em um fluxo governado: um ciclo de vida com estados, papéis, transições controladas, visibilidade controlada por permissões por estado e trilha de auditoria. É o passo além do versionamento simples de arquivos (rascunho → publicado), para quando o processo em si precisa ser garantido.
Quando usar governança formal
Considere uma Classe de Documento quando a elaboração e consumo do conteúdo requer:
- Aprovação em etapas — redigir → revisar → aprovar (ou fluxos mais elaborados)
- Papéis por etapa — pessoas diferentes (usuários do projeto) agindo em momentos diferentes
- Confidencialidade por estágio — quem pode ver o documento depende do estado em que ele está em seu ciclo de vida no momento
- Trilha de auditoria — registro formal de cada mudança de estado, com autor e justificativa
Para controle mais leve — rastrear revisões de um arquivo sem fluxo de aprovação formal — o versionamento de arquivos (rascunho/publicado) já resolve. Veja Sistema de Versionamento de Arquivos.
Requisito de plano: As Classes de Documentos são um recurso do plano Max.
Conceitos Principais
Classe de Documento
Uma Classe de Documento nasce de uma categoria de registros "graduada" para um fluxo governado. Além dos campos de metadados que toda categoria tem, ela ganha um ciclo de vida configurável. O preset padrão dos papéis da classe é autor → revisor → aprovador, totalmente ajustável depois.
Ciclo de vida (lifecycle)
O ciclo de vida define como um documento se move e quem pode agir. Ele é composto de:
- Estados — as etapas do fluxo (ex.: Em elaboração → Em revisão → Aprovado). Normalmente um estado é o inicial (mas podem ser mais de um); alguns podem ser terminais.
- Papéis (Roles) — os papéis da classe (ex.: autor, revisor, aprovador), distintos das funções do projeto. Após a definição dos papéis da classe, o administrador poderá atribuir um deles a cada usuário. Caso um usuário não tenha nenhum papel atribuído em uma determinada classe, será como se a classe não existisse para ele (need-to-know).
- Transições (ações) — os movimentos permitidos entre estados (ex.: "submeter", "aprovar", "rejeitar"), cada um com os papéis que podem dispará-lo; algumas transições exigem uma justificativa (nota). Uma transição também pode exigir, opcionalmente, que o documento esteja "pronto": que todos os seus arquivos tenham versão publicada e/ou que não haja comentário em aberto.
- Matriz papel × estado — para cada estado, quem pode ler e quem pode escrever. Um par (estado, papel) ausente significa sem acesso.
Documento governado
Um documento governado é uma entrada que pertence a uma Classe. Ele existe como uma família com uma ou mais versões (revisões), e cada versão está sempre em um estado do ciclo de vida. Classes versionadas (o versionamento de uma classe é opcional) têm um eixo de versão (ex.: rev A, B, C); novas revisões nascem em um estado de entrada.
Visibilidade need-to-know
A matriz de permissões por estado implementa a confidencialidade por estágio: um documento só é visível a quem tem pelo menos acesso de leitura no estado atual. Na prática, um documento em elaboração pode ficar invisível para quem só deveria vê-lo depois de aprovado. Isso vale inclusive na navegação — o espaço de Conteúdo Governado mostra a cada pessoa apenas as classes e documentos que ela pode ver.
Trilha de auditoria
Toda transição fica registrada: qual ação, quem disparou, quando e com qual justificativa. É o histórico formal que a governança exige.
Do versionamento simples ao ciclo governado
Governança e versionamento de arquivos são dois pontos de um mesmo espectro — o de "estado → transição → auditoria":
| Versionamento de arquivos | Classes de Documentos | |
|---|---|---|
| Aplica-se a | Qualquer arquivo | Records de uma categoria graduada |
| Estados | Rascunho, Publicado (fixos) | Personalizados (ex.: Em elaboração → Em revisão → Aprovado) |
| Como avança | Checkout/checkin e publicar | Transições nomeadas, com papéis e nota |
| Visibilidade | Todos que acessam o arquivo | Need-to-know: por estado e papel |
| Auditoria | Histórico de versões | Registro de cada transição |
| Plano | Todos | Max |
Comece com rascunho/publicado para controle simples; migre para Classes de Documentos quando o processo exigir aprovações formais, papéis dedicados e confidencialidade por estágio.
Observe que os dois processos podem conviver. Por exemplo, um documento em elaboração pode ter um arquivo editado e comentado por mais de um usuário autorizado. Somente quando uma versão do arquivo for publicada é que o documento que o contém poderá avançar no ciclo de vida da sua classe — desde que a transição esteja configurada para exigir versão publicada.
Papéis e Permissões
Há dois níveis de permissão na governança:
- Configurar a governança (graduar uma categoria, editar o ciclo de vida) — restrito a proprietário e administrador, no plano Max.
- Operar os documentos (criar, ler, disparar transições) — controlado pela matriz papel × estado definida em cada Classe. Ou seja, quem pode aprovar, rejeitar ou apenas ler depende do papel da pessoa naquela classe e do estado atual do documento — não apenas da função no projeto.
A visibilidade das classes também é need-to-know: proprietário e administrador enxergam todas; membros e visualizadores, apenas as classes onde têm um papel.
Perguntas Frequentes
P: Qual a diferença entre publicar uma versão de arquivo e uma Classe de Documento?
R: Publicar uma versão de um arquivo cria um snapshot dentro do ciclo simples rascunho → publicado. Uma Classe de Documento adiciona um fluxo de aprovação governado — vários estados, papéis por etapa, visibilidade need-to-know e trilha de auditoria — para records estruturados.
P: Preciso do plano Max?
R: Sim. Graduar categorias e configurar ciclos de vida são recursos do plano Max. Sem ele, a página de Document Classes é visível, mas a graduação fica bloqueada (com aviso de upgrade).
P: Papéis da classe são o mesmo que funções do projeto?
R: Não. As funções do projeto (proprietário, administrador, membro, visualizador) governam o acesso geral. Os papéis da classe (ex.: autor, revisor, aprovador) são específicos do fluxo governado e determinam quem pode agir em cada estado.
P: Um documento em elaboração pode ser escondido de parte da equipe?
R: Sim — é o propósito da visibilidade need-to-know. A matriz papel × estado define, por estado, quem lê e quem escreve; quem não tem acesso naquele estado simplesmente não vê o documento.
Versão do Documento: 1.0 Última Atualização: Julho de 2026 Autor: Equipe de Desenvolvimento Sutram