Suporte Okai

Tudo o que você precisa para tirar dúvidas sobre cursos, certificados, pontuação do CRC e OK.

Índice da coleção

Configurar tipos de documentos

Aplica-se a: Configuração dos tipos de documentos em Config do workspace, incluindo árvore de classificação, descrição de uso, máscara de numeração, ativação, reorganização e diagnóstico de documentos classificados incorretamente.

Tipo de documento não é só um rótulo

Tipos de documentos organizam como o workspace reconhece políticas, evidências, anexos e artefatos. Quando a classificação é bem desenhada, a busca encontra o arquivo certo e uma auditoria segue o caminho entre documento, tarefa e decisão.

Use o tipo para responder que papel aquele documento cumpre na operação. Uma política aprovada, um parecer jurídico, uma evidência de execução de controle e uma planilha de apoio podem ser todos arquivos PDF ou planilhas, mas não têm a mesma finalidade. O tipo deve refletir essa finalidade, não apenas o formato do arquivo.

A configuração também influencia governança: descrição, posição na árvore, status ativo ou inativo e, quando necessário, máscara de numeração. O código técnico é preservado pela aplicação.

Classificação não corrige contexto errado: Se uma evidência foi anexada ao projeto quando deveria estar na tarefa, alterar o tipo não resolve a rastreabilidade. Primeiro corrija o vínculo ou o local do registro.

Antes de criar a árvore

Comece pela rotina real do workspace. Liste os documentos que já circulam em projetos, tarefas, controles, requisitos, achados, políticas internas e auditorias. Em seguida, agrupe por finalidade, ciclo de vida e evidência necessária.

  • Separe documentos que comprovam execução de documentos que apenas apoiam análise. Evidência, apoio e artefato final costumam pedir tratamento diferente.
  • Identifique documentos que precisam ser encontrados depois por busca ou filtro, como políticas vigentes, atas de aprovação, relatórios de teste e pareceres.
  • Evite tipos por ano, área momentânea, nome de fornecedor ou extensão do arquivo. Esses dados mudam e geralmente pertencem a campos, tags, filtros ou metadados.
  • Use nomes que a operação reconhece sem legenda, como Política interna, Evidência de controle, Parecer regulatório ou Material de apoio.
  • Defina o tratamento de documentos antigos antes de renomear, inativar ou excluir qualquer tipo já usado.

Tipo genérico demais vira dado ruim: Um tipo chamado Documento, Arquivo ou Geral raramente ajuda na busca, no filtro ou na auditoria. Se a dúvida aparece sempre, revise a taxonomia.

Como configurar na prática

  1. Abra Config no workspace correto: Confirme o workspace ativo antes de alterar tipos. Essa configuração pertence ao ambiente de trabalho e afeta os documentos classificados ali.
  2. Entre em Tipos de documentos: A tela apresenta uma árvore editável. As raízes visuais aparecem no primeiro nível, mesmo que a plataforma preserve internamente uma raiz técnica de documentos.
  3. Crie o tipo com título claro: Use um nome curto e operacional, que funcione em seleção, filtro, árvore e leitura rápida no Explorer.
  4. Escolha a pasta superior: Use a pasta superior para uma hierarquia simples, como Governança, Evidências, Apoio e Entregáveis. Profundidade excessiva aumenta classificação inconsistente.
  5. Escreva uma descrição de uso: Diga quando escolher aquele tipo e quando não escolher. Exemplos concretos ajudam mais do que definições formais.
  6. Defina máscara de numeração quando fizer sentido: Se documentos desse tipo precisam de número automático próprio, configure a máscara. Sem regra específica, deixe em branco para usar o padrão do workspace.
  7. Salve e revise a árvore: Depois de criar ou editar, valide se o item aparece no lugar esperado. Ao reorganizar por drag-and-drop, salve a ordem antes de continuar.

Ordem pendente precisa ser salva: Ao mover tipos na árvore, a alteração fica pendente até salvar a ordem. Conclua essa etapa antes de fazer novas edições.

Nome, descrição e numeração

O título aparece no uso diário; a descrição orienta a classificação; a máscara de numeração cria uma regra operacional. Tratar esses campos como a mesma coisa gera tipos ambíguos.

  • Título bom: Parecer regulatório. Título fraco: Documento regulatório, porque não explica se é fonte, análise, evidência ou decisão.
  • Descrição boa: Use para manifestações técnicas ou jurídicas que sustentam uma decisão sobre norma, requisito, controle ou projeto.
  • Máscara útil: DOC-{seq:000000} para uma sequência simples ou POL-{yyyy}-{seq:0000} quando o ano precisa compor o número.
  • Tokens aceitos na numeração incluem {seq}, {seq:000}, {yyyy}, {yy}, {mm}, {area} e {tipo}. A sequência é obrigatória para gerar números únicos com segurança.
  • Não use numeração para codificar informação que deveria ficar em campo próprio, como status, responsável ou área impactada.

Máscara por tipo deve ser exceção consciente: Se todos os documentos seguem a mesma regra, prefira a máscara padrão do workspace. Use máscara por tipo quando a família exigir numeração diferente.

Evidência, apoio e artefato final

Uma boa taxonomia deixa claro o nível de compromisso do documento. Evidência comprova que algo aconteceu. Apoio ajuda a analisar ou executar. Artefato final representa uma entrega formal, aprovada ou publicada.

  • Use tipos de evidência para documentos que sustentam conclusão, aprovação, execução de controle, cumprimento de requisito ou resposta a achado.
  • Use tipos de apoio para materiais intermediários, planilhas de cálculo, rascunhos, referências recebidas e anexos que ajudam a executar a atividade.
  • Use tipos de artefato final para políticas, relatórios, atas, planos, matrizes ou entregáveis que representam resultado consolidado.
  • Quando uma tarefa exige comprovação, anexe a evidência na tarefa ou no ponto correto do fluxo, não apenas no projeto pai.
  • Quando apoio vira entrega final, avalie se a mudança é de tipo, de versão ou de registro antes de sobrescrever histórico.

Alterar, inativar ou excluir

Tipos de documentos acumulam histórico. Depois que um tipo foi usado, a decisão mais segura muitas vezes é inativar para novas classificações, não excluir. Assim, documentos antigos continuam rastreáveis.

  1. Renomeie quando o significado continuar o mesmo: Corrija clareza ou padronização sem mudar a finalidade. Se o novo nome muda o conceito, crie um tipo novo e planeje reclassificação.
  2. Inative quando o tipo não deve mais ser escolhido: Use inativação para categorias substituídas, obsoletas ou restritas a histórico. Documentos existentes continuam classificados.
  3. Exclua apenas quando não houver dependências: A exclusão é bloqueada para o tipo padrão Outros, para tipos com subtipos e para tipos já usados por artefatos.
  4. Reorganize a hierarquia com cuidado: Mover um tipo muda como a categoria é encontrada. Antes de salvar uma grande reorganização, confirme se os nomes ainda fazem sentido.

Não esconda erro semântico com renomeação: Se documentos de evidência aparecem como material de apoio, renomear Material de apoio para Evidência apenas mascara o erro. Investigue a classificação original, o vínculo do documento e o fluxo que criou o registro.

Validar no uso real

Depois de configurar, valide a árvore em situações reais. Crie ou edite documentos representativos, aplique tipos diferentes, pesquise no Explorer, filtre listas e abra tarefas ou projetos que dependem de evidências. A configuração está boa quando a escolha parece natural durante o trabalho.

  • A lista de tipos não obriga a equipe a escolher Outros para documentos comuns.
  • Os principais documentos aparecem em filtros e buscas com o tipo esperado.
  • Evidências ficam ligadas à tarefa, projeto, controle, requisito ou achado correto.
  • Descrições ajudam a decidir entre tipos parecidos sem consulta externa.
  • Tipos inativos deixam de aparecer para novas classificações, mas continuam preservando histórico.
  • Máscaras de numeração geram números previsíveis e únicos para os documentos que precisam delas.

Diagnóstico quando algo parece errado

Quando a classificação não funciona como esperado, investigue a primeira camada incorreta. A causa costuma estar no tipo escolhido, no vínculo do documento, na árvore, na máscara ou no estado ativo do tipo.

  • Tipo não aparece ao classificar: confira se está ativo, se pertence ao workspace correto e se a ordem pendente da árvore já foi salva.
  • Tipo aparece no lugar errado: revise a pasta superior e salve a organização da árvore após drag-and-drop.
  • Documento não aparece no filtro esperado: confirme se o documento foi salvo com aquele tipo e se não está em outro workspace ou contexto.
  • Evidência não é encontrada na auditoria: verifique se foi anexada ao registro correto, como tarefa ou projeto específico, antes de alterar a classificação.
  • Máscara de numeração falha: confirme se há token de sequência, como {seq} ou {seq:000}, e se os demais tokens são suportados.
  • Exclusão bloqueada: procure subtipos ou documentos já classificados com aquele tipo. Quando houver histórico, inativar pode ser a decisão correta.

Informações úteis para suporte: Ao pedir ajuda, informe workspace, nome do tipo, exemplo de documento, vínculo esperado, resultado no filtro ou busca, máscara usada e mensagem exibida.