Documentação do JSONForms: Uma Abordagem com Technical Writing

Abstract

This 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.