[Sugestão] engenharia

Nesta aula, tive a oportunidade de entender melhor a importância da documentação e dos testes automatizados dentro de um projeto. Ficou claro como uma documentação atualizada faz diferença na hora de manter o sistema funcionando, facilita o entendimento para quem está entrando agora e serve como base para futuras melhorias.

Aprendi também a estruturar uma documentação eficiente, começando por uma introdução clara e incluindo pontos essenciais como as regras de negócio, o objetivo do projeto e o contexto em que ele está inserido. Além disso, vimos como o README é uma peça central dentro do repositório, servindo como porta de entrada para quem vai usar ou contribuir com o código.

Outro ponto que foi trabalhado é a elaboração de um resumo executivo, que ajuda a apresentar os resultados de forma clara e objetiva, especialmente quando o público é de fora da área técnica.

Sobre testes, entendi como eles são fundamentais para garantir a qualidade e confiabilidade do código. Aprendi a usar o PyTest para escrever testes unitários e também a usar fixtures para preparar o ambiente de teste, o que evita repetição de código e torna os testes mais organizados.

Por fim, também vimos como desenvolver um plano de ação para aumentar a cobertura dos testes no projeto, identificando o que já está coberto e o que ainda precisa ser validado. Isso ajuda a ter uma visão mais completa sobre a robustez do sistema e diminui os riscos de erros passarem despercebidos.