Relatório técnico

Versionamento e Manutenção

Imagem padrão
Ouvir conteúdo
Clique para ouvir o texto completo

13.1 Controle de Versionamento

  • Objetivo: Registrar todas as alterações no sistema, permitindo reverter mudanças e manter histórico completo.

  • Práticas recomendadas:

    • Utilizar Git ou outro sistema de versionamento distribuído.

    • Criar branches para novos módulos ou alterações significativas.

    • Documentar cada commit com descrição clara do que foi alterado, corrigido ou adicionado.

    • Taggear versões estáveis (ex.: v1.0-pregao-moedas, v1.1-chat-ia).

13.2 Estrutura de Pastas e Arquivos

  • Objetivo: Manter organização consistente entre os módulos de moedas e cédulas, facilitando manutenção e evolução.

  • Exemplo de estrutura atual:

pregao/

├── config/

│ └── databaseNexa.php

├── assets/
 
│ ├── css/

│ └── js/

├── moedas/

│ ├── includes/

│ │ ├── header.php

│ │ ├── menu.php

│ │ ├── footer.php

│ │ ├── funcoes.php

│ │ ├── card_moeda.php

│ │ ├── card_lances.php

│ │ ├── card_chat.php

│ │ ├── card_info.php

│ │ └── login_form.php

│ └── index.php

└── cedulas/
  • Sugestão de melhoria: separar microsistemas e assets comuns (CSS, JS) para reduzir duplicidade e facilitar atualizações.

13.3 Atualizações e Correções

  • Objetivo: Garantir que bugs e problemas técnicos sejam corrigidos de forma organizada e sem comprometer o sistema ativo.

  • Práticas recomendadas:

    • Criar tickets ou registros de problemas identificados.

    • Validar correções em ambiente de teste antes de aplicar em produção.

    • Registrar cada atualização com data, autor e descrição detalhada da mudança.

13.4 Backup e Recuperação

  • Objetivo: Proteger dados do pregão, incluindo usuários, lances e histórico de vendas.

  • Práticas recomendadas:

    • Backups diários do banco de dados e arquivos essenciais.

    • Testar periodicamente a restauração de backups.

    • Armazenar backups em local seguro e com redundância.

13.5 Registro de Mudanças (Changelog)

  • Objetivo: Manter histórico detalhado das versões e evoluções do sistema.

  • Formato sugerido:

 
v1.0 (2026-01-22) - Lançamento do pregão de moedas - Implementação do catálogo com imagens frente/verso - Chat do pregão funcional - Botão de ficha técnica implementado v1.1 (2026-01-30) - Adição de controle de lances (não aceita empate) - Destaque da primeira moeda - Melhorias de responsividade no catálogo
  • Benefício: facilita auditoria, manutenção e planejamento de novas evoluções.

13.6 Sugestões de Manutenção Preventiva

  • Revisão periódica de queries que carregam grandes volumes de dados.

  • Otimização de imagens no catálogo para melhorar performance.

  • Monitoramento de logs de erros PHP e SQL.

  • Verificação de links externos (ficha técnica, endpoints) para evitar erros de acesso.

Tire suas dúvidas

Cecília Romani
Cecília Romani

Especialista em Numismática

Tire suas dúvidas com Cecília Romani sobre este capítulo pelo WhatsApp.

Falar com Cecília

Comentários

Área de comentários em breve...