Voltar à Documentação

Sistema de Versionamento de Arquivos

Introdução

O Sistema de Versionamento de Arquivos do Sutram oferece um fluxo de trabalho colaborativo para gerenciar revisões de documentos nos seus projetos. Inspirado nas práticas tradicionais de controle de documentos de engenharia, ele permite que equipes acompanhem alterações, mantenham o histórico de revisões e garantam que apenas uma pessoa edite um arquivo por vez.

Quando Usar o Versionamento

Use o versionamento para arquivos que:

  • Exigem rastreamento formal de revisões (contratos, especificações, desenhos)
  • São editados por vários membros da equipe
  • Precisam de fluxos de aprovação antes da publicação
  • Necessitam de uma trilha de auditoria das alterações

Arquivos que normalmente não precisam de versionamento:

  • Materiais de referência que não mudam
  • Relatórios ou snapshots exportados
  • Arquivos de mídia (imagens, vídeos)

Conceitos Principais

Tipos de Arquivo

Todo arquivo no Sutram é um arquivo de Referência ou Editável:

Tipo Descrição Versionamento
Referência Arquivos padrão sem controle de versão. Qualquer pessoa com permissão de edição pode substituir o arquivo a qualquer momento. Desabilitado
Editável Arquivos com controle de versão habilitado. Requer checkout antes da edição e suporta versionamento formal. Habilitado

Por padrão, todos os arquivos enviados são arquivos de Referência. Você pode habilitar o versionamento em qualquer arquivo.

Status do Ciclo de Vida

Arquivos editáveis possuem um status de ciclo de vida que indica seu estado atual:

Status Descrição
Rascunho Trabalho em andamento. Pode ser editado via checkout/checkin. Ainda não foi formalmente publicado.
Publicado Versão formalmente publicada. Cria um snapshot permanente no histórico de versões.

Checkout/Checkin

O sistema de checkout/checkin garante que apenas uma pessoa possa editar um arquivo por vez:

  • Checkout: Reserva o arquivo para sua edição exclusiva. Outros podem visualizar, mas não modificar.
  • Checkin: Devolve o arquivo com suas alterações. Requer o envio de uma nova versão do arquivo.

Isso evita edições conflitantes e garante um registro claro de quem fez as alterações.

Versões

Quando você publica um arquivo, o Sutram cria um snapshot permanente chamado Versão. As versões são numeradas sequencialmente (v1, v2, v3...) e não podem ser modificadas ou excluídas. Isso proporciona:

  • Histórico completo de revisões
  • Possibilidade de baixar qualquer versão anterior
  • Trilha de auditoria clara das publicações

Primeiros Passos

Habilitando o Versionamento em um Arquivo

Para habilitar o versionamento em um arquivo existente:

  1. Navegue até a aba Conteúdo do seu projeto
  2. Encontre o arquivo no qual deseja habilitar o versionamento
  3. Clique no menu ... (mais opções)
  4. Selecione "Habilitar versionamento"

O arquivo se tornará um arquivo Editável com status de Rascunho.

Nota: Apenas Proprietários e Membros do projeto podem habilitar o versionamento.

Desabilitando o Versionamento

Para desabilitar o versionamento e converter de volta para um arquivo de Referência:

  1. Certifique-se de que o arquivo não está em checkout
  2. Clique no menu ... do arquivo
  3. Selecione "Desabilitar versionamento"

Atenção: Desabilitar o versionamento remove a possibilidade de usar checkout/checkin, mas não exclui o histórico de versões.


Fluxo de Trabalho de Checkout/Checkin

Passo 1: Fazer Checkout de um Arquivo

Antes de editar um arquivo editável, você deve fazer o checkout:

  1. Clique no menu ... do arquivo
  2. Selecione "Fazer checkout para edição"
  3. O arquivo agora está reservado para sua edição exclusiva

Após o checkout:

  • O arquivo exibe um selo "Em checkout por [Seu Nome]"
  • Outros usuários podem visualizar, mas não podem fazer checkout do arquivo
  • Você pode baixar a versão atual para editar localmente

Passo 2: Editar o Arquivo Localmente

  1. Baixe o arquivo atual do Sutram
  2. Faça suas alterações usando o software apropriado (Word, AutoCAD, etc.)
  3. Salve o arquivo modificado no seu computador

Passo 3: Fazer Checkin com Suas Alterações

Quando estiver pronto para salvar suas alterações:

  1. Clique no menu ... do arquivo
  2. Selecione "Fazer checkin"
  3. Uma caixa de diálogo aparece solicitando o envio do arquivo modificado
  4. Arraste e solte ou clique para selecionar o arquivo atualizado
  5. Aguarde o upload ser concluído

Importante: O arquivo de substituição deve ter a mesma extensão do original (por exemplo, arquivos .docx devem ser substituídos por arquivos .docx).

Cancelando um Checkout

Se você decidir não fazer alterações:

  1. Clique no menu ... do arquivo em checkout
  2. Selecione "Cancelar checkout"

Isso libera o arquivo sem nenhuma alteração. O arquivo retorna ao seu estado anterior.

Desfazendo um Checkin

Cometeu um erro? Se um backup estiver disponível:

  1. Clique no menu ... do arquivo
  2. Selecione "Desfazer checkin"
  3. A versão anterior é restaurada

Nota: Desfazer só está disponível se existir um backup (normalmente imediatamente após o checkin). Quando você fizer checkout e checkin novamente, o backup anterior será sobrescrito.

Forçar Liberação de Bloqueio (Apenas Proprietários)

Se um membro da equipe fez checkout de um arquivo, mas não está disponível:

  1. Como Proprietário do Projeto, clique no menu ...
  2. Selecione "Forçar liberação de bloqueio"

Isso libera o bloqueio imediatamente. Quaisquer alterações não salvas pelo usuário original serão perdidas.

Use com cautela: Utilize apenas quando necessário, pois pode causar perda de trabalho.


Gerenciamento de Versões

Publicando uma Versão

Quando um rascunho estiver pronto para publicação formal:

  1. Certifique-se de que o arquivo não está em checkout
  2. Clique no menu ...
  3. Selecione "Publicar versão"

Isso cria um snapshot permanente:

  • O número da versão é incrementado (v1 → v2 → v3...)
  • O snapshot é armazenado no histórico de versões
  • O status do arquivo muda para Publicado

Nota: Apenas Proprietários do Projeto podem publicar versões.

Criando uma Nova Versão a Partir de uma Publicada

Para continuar editando um arquivo publicado:

  1. Clique no menu ... de um arquivo Publicado
  2. Selecione "Criar nova versão"

Isso:

  • Cria um novo Rascunho a partir da versão publicada
  • Incrementa o número da versão
  • Permite que você faça checkout e realize alterações

Visualizando o Histórico de Versões

Para ver todas as versões publicadas:

  1. Clique no arquivo para abri-lo
  2. Clique em "Histórico de Versões" no visualizador
  3. Uma linha do tempo mostra todas as versões publicadas com:
    • Número da versão
    • Data de publicação
    • Quem publicou

Baixando Versões Anteriores

No modal de Histórico de Versões:

  1. Encontre a versão desejada
  2. Clique no ícone de download ao lado da versão
  3. O arquivo histórico é baixado para o seu computador

Isso é útil para:

  • Comparar alterações entre versões
  • Reverter para um projeto anterior
  • Necessidades de auditoria e conformidade

Permissões e Funções

Diferentes funções no projeto possuem diferentes capacidades de versionamento:

Ação Proprietário Admin Membro Visualizador
Visualizar arquivos e versões Sim Sim Sim Sim
Baixar versões Sim Sim Sim Sim
Habilitar/desabilitar versionamento Sim Sim Sim Não
Fazer checkout de arquivos Sim Sim Sim Não
Fazer checkin de arquivos Sim Sim Sim Não
Cancelar próprio checkout Sim Sim Sim Não
Desfazer checkin Sim Sim Sim Não
Publicar versões Sim Não Não Não
Criar nova versão Sim Não Não Não
Forçar liberação de bloqueio Sim Não Não Não

Pontos Principais:

  • Apenas Proprietários podem publicar versões e criar novas versões
  • Apenas Proprietários podem forçar a liberação de bloqueios de outros usuários
  • Visualizadores podem apenas visualizar e baixar, não editar

Indicadores Visuais

Selos de Status

Arquivos editáveis exibem selos mostrando seu estado atual:

Selo Significado
Rascunho (âmbar) O arquivo é um trabalho em andamento, ainda não publicado
Publicado (índigo) O arquivo foi formalmente publicado como uma versão
Em checkout por [Nome] (alerta) O arquivo está bloqueado para edição pelo usuário indicado

Identificando Arquivos Bloqueados

Quando um arquivo está em checkout:

  • Um ícone de cadeado aparece na lista de arquivos
  • O selo mostra quem fez o checkout
  • A opção de checkout fica oculta (arquivo indisponível)

Seus Próprios Checkouts

Quando você tem um arquivo em checkout:

  • A opção "Fazer checkin" aparece no menu
  • A opção "Cancelar checkout" está disponível
  • Outros usuários veem que você bloqueou o arquivo

Boas Práticas

Quando Habilitar o Versionamento

Habilite o versionamento para:

  • Desenhos e especificações de engenharia
  • Contratos e documentos legais
  • Planos e cronogramas de projeto
  • Qualquer documento que exija aprovação formal

Evite o versionamento para:

  • Arquivos de trabalho atualizados frequentemente
  • Imagens ou mídias de referência
  • Relatórios exportados (crie novos arquivos)

Fluxo de Trabalho de Publicação

Fluxo recomendado para documentos formais:

  1. Criar/Enviar: Adicione o arquivo inicial ao projeto
  2. Habilitar Versionamento: Converta para arquivo editável
  3. Trabalhar no Rascunho: Faça edições via checkout/checkin
  4. Revisar: Compartilhe o rascunho com a equipe para feedback
  5. Publicar: Quando aprovado, publique como versão formal
  6. Iterar: Crie nova versão para futuras alterações

Dicas de Coordenação da Equipe

  • Comunique-se: Avise sua equipe quando fizer checkout de arquivos
  • Não acumule: Faça checkin dos arquivos prontamente quando terminar
  • Publique regularmente: Publique versões estáveis com frequência, não apenas em marcos
  • Use comentários: Adicione contexto no chat do projeto ao publicar alterações importantes

Perguntas Frequentes

P: Posso editar um arquivo sem fazer checkout?

R: Para arquivos de Referência, sim. Para arquivos Editáveis, não — você deve fazer checkout primeiro. Isso garante que apenas uma pessoa edite por vez.

P: O que acontece se eu esquecer de fazer checkin de um arquivo?

R: O arquivo permanece bloqueado para você até que faça checkin ou cancele. Se você ficar indisponível, o Proprietário do Projeto pode forçar a liberação do bloqueio.

P: Posso excluir uma versão publicada?

R: Não. Versões publicadas são permanentes para fins de auditoria. Você pode criar novas versões, mas o histórico é preservado.

P: Qual a diferença entre versões e histórico do arquivo?

R: Versões são snapshots formais e numerados criados pela publicação. Cada versão é permanente e pode ser baixada. Checkins sem publicação atualizam a cópia de trabalho, mas não criam versões numeradas.

P: Várias pessoas podem fazer checkout do mesmo arquivo?

R: Não. Apenas uma pessoa pode ter um arquivo em checkout por vez. Isso é intencional para evitar edições conflitantes.

P: Eu perco minhas alterações se alguém forçar a liberação do meu bloqueio?

R: Sim, quaisquer alterações não submetidas via checkin serão perdidas. Faça checkin regularmente. A liberação forçada deve ser usada apenas quando necessário.

P: Posso habilitar o versionamento em arquivos CAD?

R: Sim! O versionamento funciona com qualquer tipo de arquivo — desenhos CAD, documentos Office, PDFs e muito mais.


Solução de Problemas

"O arquivo já está em checkout"

Problema: Você não consegue fazer checkout de um arquivo porque outra pessoa o possui.

Solução:

  1. Verifique o selo para ver quem fez o checkout
  2. Entre em contato para coordenar
  3. Se for urgente e a pessoa não estiver disponível, peça ao Proprietário do Projeto para forçar a liberação

"Você não possui este arquivo em checkout"

Problema: Você está tentando fazer checkin, mas não tem o arquivo em checkout.

Solução: Faça checkout do arquivo primeiro, depois faça suas alterações e realize o checkin.

"O arquivo deve ter a extensão: .xyz"

Problema: Você está tentando fazer checkin de um arquivo com uma extensão diferente.

Solução: Certifique-se de que o arquivo de substituição tem a mesma extensão do original. Por exemplo, um arquivo .docx deve ser substituído por outro arquivo .docx.

"Apenas o proprietário do projeto pode publicar arquivos"

Problema: Você não tem permissão para publicar.

Solução: Peça ao Proprietário do Projeto para publicar a versão, ou solicite que ele altere sua função.

Falha no upload durante o checkin

Problema: O upload durante o checkin não é concluído.

Solução:

  1. Verifique sua conexão com a internet
  2. Certifique-se de que o arquivo não é muito grande (verifique os limites do projeto)
  3. Tente novamente com um arquivo menor ou melhor conexão
  4. Se o problema persistir, entre em contato com o suporte

Histórico de versões não aparece

Problema: Você não consegue ver o histórico de versões de um arquivo.

Solução: O histórico de versões só aparece para arquivos que foram publicados pelo menos uma vez. Se o arquivo ainda está em Rascunho e nunca foi publicado, ainda não há histórico de versões.


Versão do Documento: 1.0 Última Atualização: Novembro de 2025 Autor: Equipe de Desenvolvimento Sutram