O objetivo desse artigo é apresentar formas que facilitem que os programadores façam a documentação do projeto, bem como a utilização de ferramentas apropriadas, facilitando até mesmo na reengenharia do código. Pois como sabemos o processo da documentação é muito complexo, ao envolver vários fatores que podem impactar em custos, prazos,
cronogramas e na qualidade do software. A documentação tem uma relevância na manutenção do software por facilitar o entendimento dos programadores sobre o código existente, possibilitando modificações ou correções quando necessário de uma forma mais fácil de se entender. Mais abaixo serão apresentadas algumas estratégias possíveis para auxiliar os programadores no desenvolvimento da documentação de uma forma mais simples e rápida. Espécie de exemplos do que deve ser feito: fluxogramas e casos de uso, ferramentas de projetos que fazem toda a diferença na documentação. Por mais que a documentação do projeto seja algo que o desenvolvedor não goste de fazer, ela é uma etapa essencial para o
bom andamento do projeto, por ser onde o time irá se basear na hora de desenvolver o software. Sendo assim, caso ocorra algum problema, é na documentação que encontraremos a maioria das respostas, pois tudo estará documentado. A documentação é um passo que dura o projeto inteiro, mesmo durante as alterações incrementais. Isto acontece porque tais
documentos funcionam como um manual do desenvolvedor, onde se diz o que tem de ser feito e como. Ao final deste artigo entenderemos melhor a importância da documentação e quais ferramentas poderemos utilizar para desenvolvê-la.
Esta coletânea de caráter muldiciplinar apresenta uma compilação de estudos técnico-científicos inovadores e aprofundados de diferentes áreas do conhecimento. A coletânea é constituída de artigos apresentados em cada uma das áreas temáticas do II UniSIAE - Semana Integrada de Agronomia, Arquitetura e Urbanismo, Análise e Desenvolvimento de Sistemas, e Engenharias Civil, Mecânica, de Produção e Software, realizado na UniCesumar de Ponta Grossa entre os dias 6 e 10 de novembro de 2023.
Tanto o evento precursor desta publicação quanto a coletânea em si estão alinhados à política institucional de fomento à pesquisa acadêmica, destacando-a como um princípio educativo que impulsiona a prática pedagógica no ambiente universitário. O propósito é desenvolver uma habilidade constante de questionamento reconstrutivo para a formação humana e profissional, visando a formação de indivíduos capacitados e compromissados com a busca por soluções para os desafios contemporâneos.
Esperamos que a divulgação desta coletânea contribua para disseminar esses estudos na comunidade científica, inspirando acadêmicos e pesquisadores a explorarem inovações e aplicações em diversas áreas do conhecimento.
Além da orientação para as referências e citações, as demais formatações do trabalho devem seguir os padrões nacionais da ABNT disponível no documento “Princípios Gerais para Elaboração e Apresentação de Trabalhos Acadêmico- Científicos” disponível no ambiente Studeo.
Considera-se fraude acadêmica tudo o que provem de plágio, ou seja, a ação de se apropriar de ideias, pensamentos, artigos ou partes desses sem citar a fonte. Essa atitude, além de ser repudiada pelo meio acadêmico que, acima de tudo, valoriza o mérito intelectual, configura-se em crime previsto na Lei de Direitos Autorais. Para efeito deste regulamento, será considerado como plágio, todo o texto em que for detectado algum tipo de violação de direito autoral, conforme previsto na legislação em vigor, Lei 9.610 (Lei de Direitos Autorais e previsto em Crime de Violação aos Direitos Autorais no Art. 184) – Código Penal.
Dr. Adalci Leite Torres (http://lattes.cnpq.br/1415327946551430)
Dra. Flávia Sayuri Arakawa (http://lattes.cnpq.br/0559271781682063)
Msc. Jeanine Mafra Migliorini (http://lattes.cnpq.br/0348383358783885)
Msc. Maicon Ramon Bueno (http://lattes.cnpq.br/5192006905102639)
Adalci leite Torres. E-mail: adalci.torres@unicesumar.edu.br
Flávia Sayuri Arakawa. E-mail: flavia.arakawa@unicesumar.edu.br
Jeanine Mafra Migliorini. E-mail: jeanine.migliorini@unicesumar.edu.br
Maicon Ramon Bueno. E-mail: maicon.bueno@unicesumar.edu.br
CONSELHO EDITORIAL - COMITÊ ORGANIZADOR
Adalci Leite Torres - Professor Doutor do Centro de Ciência Exatas, Tecnológicas e Agrárias da Unicesumar de Ponta Grossa. (adalci.torres@unicesumar.edu.br)
Flávia Sayuri Arakawa - Professora Doutora do Centro de Ciência Exatas, Tecnológicas e Agrárias da Unicesumar de Ponta Grossa. (flavia.arakawa@unicesumar.edu.br)
Jeanine Mafra Migliorini - Professora Mestre do Centro de Ciência Exatas, Tecnológicas e Agrárias da Unicesumar de Ponta Grossa. (jeanine.milgiorini@unicesumar.edu.br)
Maicon Ramon Bueno - Mestre Coordenador do Centro de Ciência Exatas, Tecnológicas e Agrárias da Unicesumar de Ponta Grossa. (maicon.bueno@unicesumar.edu.br)
CONSELHO EDITORIAL - COMITÊ REVISOR
Dra. Andressa Maria Woytowicz Ferrari – Professora do Departamento de Arquitetura e Urbanismo da Unicesumar de Ponta Grossa. (andressa.ferrari@unicesumar.edu.br)
Msc. Gabriela Kratsch Sgarbossa - Professora do Departamento de Arquitetura e Urbanismo da Unicesumar de Ponta Grossa. (gabriela.sgarbossa@unicesumar.edu.br)
Esp. Patricia Carvalho Schleder - Professora do Departamento de Arquitetura e Urbanismo da Unicesumar de Ponta Grossa. (patricia.schleder@unicesumar.edu.br)
Msc. Rafaela Sebrão de Rose - Professora do Departamento de Arquitetura e Urbanismo da Unicesumar de Ponta Grossa.(rafaela.rose@unicesumar.edu.br)
Esp. Vanessa Campani Vergani de Oliveira - Professora do Departamento de Arquitetura e Urbanismo da Unicesumar de Ponta Grossa. (vanessa.oliveira@unicesumar.edu.br)
Msc. Kamila Santana Rogenski – Professora do Departamento de Agronomia da Unicesumar de Ponta Grossa. (kamila.santana@uniceumar.edu.br)
Dr. Leonardo Tullio - Professor do Departamento de Agronomia da Unicesumar de Ponta Grossa. (leonardo.tullio@unicesumar.edu.br)
Msc. Janaina Semanech Borcezi – Professora do Departamento de Engenharias da Unicesumar. (janaina.borcezi@unicesumar.edu.br)
Dra. Leticia Col de Bella Santos – Professora do Departamento de Engenharia Civil da Unicesumar de Ponta Grossa. (leticia.debello@unicesumar.edu.br)
Esp. Maria Claudia Del Monaco Mikulis - Professora do Departamento de Engenharia Civil da Unicesumar de Ponta Grossa. (maria.mikulis@unicesumar.edu.br)
Msc. Mateus Edilson Gomes Dobrovolski – Professor do Departamento de Engenharia Civil da Unicesumar de Ponta Grossa. (mateus.dobrovolski@unicesumar.edu.br)
Msc. Matheus Lopes Demito - Professor do Departamento de Engenharias da Unicesumar de Ponta Grossa. (matheus.demito@unicesumar.edu.br)
Msc. Guilherme Francisco do Prado – Professor do Departamento de Engenharia de Produção da Unicesumar de Ponta Grossa (Guilherme.prado@unicesumar.edu.br)
Msc. Maria Carolina Pariz – Professora do Departamento de Engenharia de Produção da Unicesumar de Ponta Grossa. (maria.pariz@unicesumar.edu.br)
Msc. Alexandre Maier Eurich – Professor do Departamento de Engenharia Mecânica da Unicesumar de Ponta Grossa. (alexandre.eurich@unicesumar.edu.br)
Msc. Luis Carlos Menezes Almeida Junior – Professor do Departamento de Engenharias da Unicesumar de Ponta Grossa. (luiscarlos.almeida@unicesumar.edu.br)
Msc. Nicole Maria Antunes Aires – Professora do Departamento de Engenharias da Unicesumar de Ponta Grossa. (nicole.aires@unicesumar.edu.br)
Dr. Marcos Monteiro Junior – Professor do Departamento de Análise e Desenvolvimento de Sistemas e Engenharia de Software da Unicesumar de Ponta Grossa. (marcos.monteiro@unicesumar.edu.br)
Msc. Maria Carolina de Oliveira - Professora do Departamento de Análise e Desenvolvimento de Sistemas e Engenharia de Software da Unicesumar de Ponta Grossa. (maria.oliveira@unicesumar.edu.br)
Esp. Sabine Cassol - Professora do Departamento de Análise e Desenvolvimento de Sistemas e Engenharia de Software da Unicesumar de Ponta Grossa. (sabine.cassol@unicesumar.edu.br)
Msc. William Xavier Maukoski - Professor do Departamento de Análise e Desenvolvimento de Sistemas e Engenharia de Software da Unicesumar de Ponta Grossa. (william.maukoski@unicesumar.edu.br)
FACULDADE CESUMAR DE PONTA GROSSA
Rua: Desembargador Westphalem, 60 - Oficinas, Ponta Grossa - PR, 84036-350
Telefone: (42) 3700 -2250