Documentação de Software para usuários desenvolvedores: uma avaliação de bibliotecas ORM populares na plataforma Node

dc.contributor.advisorSilva, Taciano de Morais
dc.contributor.advisorIDhttps://orcid.org/0000-0002-4104-8014pt_BR
dc.contributor.advisorLatteshttp://lattes.cnpq.br/4420554987782575pt_BR
dc.contributor.authorSantos, Adriel Faria dos
dc.contributor.authorLatteshttp://lattes.cnpq.br/7379371009729855pt_BR
dc.contributor.referees1Guerra, Fabrício Vale de Azevedo
dc.contributor.referees1Latteshttp://lattes.cnpq.br/7860769003807018pt_BR
dc.contributor.referees2Chagas, José Ferdinandy Silva
dc.contributor.referees2IDhttps://orcid.org/0000-0001-8731-4341pt_BR
dc.contributor.referees2Latteshttp://lattes.cnpq.br/2571310334093508pt_BR
dc.date.accessioned2025-01-27T19:04:11Z
dc.date.available2025-01-27T19:04:11Z
dc.date.issued2025-01-17
dc.description.abstractThis work analyzes the quality of documentation for ORM libraries in the Node.js ecosystem, addressing the importance of documentation for the efficiency and maintenance of software projects. The research was motivated by the identification of gaps in the literature and in development practices, proposing clear and objective criteria for evaluating documentation. The adopted methodology included a systematic and comparative analysis of five ORM libraries, using metrics such as update frequency, completeness, ease of use, presence of code examples, and readability. The results revealed significant discrepancies between the documentation and the source code, highlighting the need for improvements in documentation maintenance. Additionally, the study emphasized the risks associated with low-quality documentation, such as misunderstandings and the introduction of errors in projects. The conclusions reinforce the relevance of clear guidelines and best practices in documentation, aiming to facilitate developers' work and foster engagement in open-source communities. This work contributes to the creation of more accessible and effective documentation aligned with market needs and opens ways for future investigations into the relationship between documentation quality and the success of software libraries.pt_BR
dc.description.resumoEste trabalho analisa a qualidade da documentação de bibliotecas ORM no ecossistema Node.js, abordando a importância da documentação para a eficiência e manutenção de projetos de software. A pesquisa foi motivada pela identificação de lacunas na literatura e, na prática de desenvolvimento, propondo critérios claros e objetivos para a avaliação das documentações. A metodologia adotada incluiu uma análise sistemática e comparativa de cinco bibliotecas ORM, utilizando métricas como atualização, completude, facilidade de uso, presença de exemplos de código e legibilidade. Os resultados revelaram discrepâncias significativas entre a documentação e o código-fonte, evidenciando a necessidade de melhorias na manutenção das documentações. Além disso, o estudo destacou os riscos associados à baixa qualidade da documentação, como mal-entendidos e introdução de erros nos projetos. As conclusões reforçam a relevância de diretrizes claras e boas práticas na documentação, visando facilitar o trabalho dos desenvolvedores e fomentar o engajamento nas comunidades de código aberto. Este trabalho contribui para a construção de documentações mais acessíveis e eficazes, alinhadas às necessidades do mercado, e abre espaço para futuras investigações sobre a relação entre a qualidade da documentação e o sucesso de bibliotecas de softwarept_BR
dc.identifier.citationSANTOS, Adriel Faria dos. Documentação de Software para usuários desenvolvedores: uma avaliação de bibliotecas ORM populares na plataforma Node. Orientador: Taciano de Morais Silva. 2025. 56 f. Trabalho de Conclusão de Curso (Graduação em Sistemas de Informação) - Departamento de Computação e Tecnologia, Universidade Federal do Rio Grande do Norte, Caicó, 2025.pt_BR
dc.identifier.urihttps://repositorio.ufrn.br/handle/123456789/62056
dc.languagept_BRpt_BR
dc.publisherUniversidade Federal do Rio Grande do Nortept_BR
dc.publisher.countryBrasilpt_BR
dc.publisher.departmentComputação e Tecnologiapt_BR
dc.publisher.initialsUFRNpt_BR
dc.publisher.programBacharelado em Sistemas de Informaçãopt_BR
dc.subjectDocumentação de softwarept_BR
dc.subjectBibliotecas ORMpt_BR
dc.subjectQualidade da documentaçãopt_BR
dc.subjectSoftware documentationpt_BR
dc.subjectORM Librariespt_BR
dc.subject.cnpqCNPQ::CIENCIAS EXATAS E DA TERRApt_BR
dc.titleDocumentação de Software para usuários desenvolvedores: uma avaliação de bibliotecas ORM populares na plataforma Nodept_BR
dc.typebachelorThesispt_BR

Arquivos

Pacote Original

Agora exibindo 1 - 1 de 1
Nenhuma Miniatura disponível
Nome:
DocumentacaoSoftwareUsuarios_Santos_2025.pdf
Tamanho:
354.48 KB
Formato:
Adobe Portable Document Format
Nenhuma Miniatura disponível
Baixar

Licença do Pacote

Agora exibindo 1 - 1 de 1
Nenhuma Miniatura disponível
Nome:
license.txt
Tamanho:
1.45 KB
Formato:
Item-specific license agreed upon to submission
Nenhuma Miniatura disponível
Baixar