Use este identificador para citar ou linkar para este item: https://repositorio.ufms.br/handle/123456789/13993
Registro completo de metadados
Campo DCValorIdioma
dc.creatorYAN GONÇALVES SANTANA-
dc.date.accessioned2025-12-08T14:00:52Z-
dc.date.available2025-12-08T14:00:52Z-
dc.date.issued2025pt_BR
dc.identifier.urihttps://repositorio.ufms.br/handle/123456789/13993-
dc.description.abstractThis project aims to complement the official JSONForms documentation by addressing aspects that, although implemented, have not been adequately documented. By applying technical writing techniques, it seeks to improve the clarity and comprehension of the content, ensuring that technical information is presented in an accessible and functional manner for developers. The initiative arose from difficulties encountered during code mining within the SIGFAP system, highlighting the need for a more structured and efficient approach. To evaluate the quality in use of the enhanced documentation, a comparative experimental study was conducted with 12 developers (6 per group), divided into two groups. Group A used the documentation developed with Technical Writing techniques, while Group B used the official documentation. Metrics for completion time (to assess Efficiency) and error rate (to assess Effectiveness) were collected, following the ISO 9241-11 definitions, to compare the performance between the groups. The final objective is to quantitatively demonstrate the impact of high-quality documentation on developer productivity and to deliver a reference material for the community.-
dc.language.isopt_BRpt_BR
dc.publisherFundação Universidade Federal de Mato Grosso do Sulpt_BR
dc.rightsAcesso Abertopt_BR
dc.subjectSONForms-
dc.subjectTechnical Writing-
dc.subjectDocumentação de Software-
dc.subjectEngenharia de Software-
dc.subjectExperiência do Desenvolvedor.-
dc.subject.classificationCiências Exatas e da Terrapt_BR
dc.titleDocumentação do JSONForms: Uma Abordagem com Technical Writingpt_BR
dc.typeTrabalho de Conclusão de Cursopt_BR
dc.contributor.advisor1AWDREN DE LIMA FONTAO-
dc.description.resumoEste trabalho tem como objetivo complementar a documentação oficial do JSONForms, abordando aspectos que, embora implementados, não foram devidamente documentados. Com a aplicação de técnicas de technical writing, busca-se aprimorar a clareza e a compreensão do conteúdo, garantindo que as informações técnicas sejam apresentadas de forma acessível e funcional para os desenvolvedores. A iniciativa surgiu a partir das dificuldades encontradas na mineração de código no contexto do sistema SIGFAP, evidenciando a necessidade de uma abordagem mais estruturada e eficiente. Para avaliar a qualidade de uso da documentação aprimorada, foi conduzido um estudo experimental comparativo com 12 desenvolvedores (6 por grupo), divididos em dois grupos. O Grupo A utilizou a documentação desenvolvida com técnicas de Technical Writing, enquanto o Grupo B utilizou a documentação oficial. Foram coletadas métricas de tempo de conclusão (para aferir Eficiência) e taxa de erros (para aferir Eficácia), fundamentadas nas definições de Usabilidade da norma ISO 9241-11, para comparar o desempenho entre os grupos. O objetivo final é demonstrar quantitativamente o impacto de uma documentação de alta qualidade na produtividade do desenvolvedor e entregar um material de referência para a comunidade.pt_BR
dc.publisher.countrynullpt_BR
dc.publisher.initialsUFMSpt_BR
Aparece nas coleções:Sistemas de Informação - Bacharelado (FACOM)

Arquivos associados a este item:
Arquivo TamanhoFormato 
23165.pdf644,89 kBAdobe PDFVisualizar/Abrir
Mostrar registro simples do item Visualizar estatísticas


Os itens no repositório estão protegidos por copyright, com todos os direitos reservados, salvo quando é indicado o contrário.